AWS SDK for C++  1.9.125
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::EndpointSummary Class Reference

#include <EndpointSummary.h>

Public Member Functions

 EndpointSummary ()
 
 EndpointSummary (Aws::Utils::Json::JsonView jsonValue)
 
EndpointSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetEndpointName () const
 
bool EndpointNameHasBeenSet () const
 
void SetEndpointName (const Aws::String &value)
 
void SetEndpointName (Aws::String &&value)
 
void SetEndpointName (const char *value)
 
EndpointSummaryWithEndpointName (const Aws::String &value)
 
EndpointSummaryWithEndpointName (Aws::String &&value)
 
EndpointSummaryWithEndpointName (const char *value)
 
const Aws::StringGetEndpointArn () const
 
bool EndpointArnHasBeenSet () const
 
void SetEndpointArn (const Aws::String &value)
 
void SetEndpointArn (Aws::String &&value)
 
void SetEndpointArn (const char *value)
 
EndpointSummaryWithEndpointArn (const Aws::String &value)
 
EndpointSummaryWithEndpointArn (Aws::String &&value)
 
EndpointSummaryWithEndpointArn (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
EndpointSummaryWithCreationTime (const Aws::Utils::DateTime &value)
 
EndpointSummaryWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastModifiedTime () const
 
bool LastModifiedTimeHasBeenSet () const
 
void SetLastModifiedTime (const Aws::Utils::DateTime &value)
 
void SetLastModifiedTime (Aws::Utils::DateTime &&value)
 
EndpointSummaryWithLastModifiedTime (const Aws::Utils::DateTime &value)
 
EndpointSummaryWithLastModifiedTime (Aws::Utils::DateTime &&value)
 
const EndpointStatusGetEndpointStatus () const
 
bool EndpointStatusHasBeenSet () const
 
void SetEndpointStatus (const EndpointStatus &value)
 
void SetEndpointStatus (EndpointStatus &&value)
 
EndpointSummaryWithEndpointStatus (const EndpointStatus &value)
 
EndpointSummaryWithEndpointStatus (EndpointStatus &&value)
 

Detailed Description

Provides summary information for an endpoint.

See Also:

AWS API Reference

Definition at line 33 of file EndpointSummary.h.

Constructor & Destructor Documentation

◆ EndpointSummary() [1/2]

Aws::SageMaker::Model::EndpointSummary::EndpointSummary ( )

◆ EndpointSummary() [2/2]

Aws::SageMaker::Model::EndpointSummary::EndpointSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CreationTimeHasBeenSet()

bool Aws::SageMaker::Model::EndpointSummary::CreationTimeHasBeenSet ( ) const
inline

A timestamp that shows when the endpoint was created.

Definition at line 132 of file EndpointSummary.h.

◆ EndpointArnHasBeenSet()

bool Aws::SageMaker::Model::EndpointSummary::EndpointArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the endpoint.

Definition at line 91 of file EndpointSummary.h.

◆ EndpointNameHasBeenSet()

bool Aws::SageMaker::Model::EndpointSummary::EndpointNameHasBeenSet ( ) const
inline

The name of the endpoint.

Definition at line 50 of file EndpointSummary.h.

◆ EndpointStatusHasBeenSet()

bool Aws::SageMaker::Model::EndpointSummary::EndpointStatusHasBeenSet ( ) const
inline

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

Definition at line 240 of file EndpointSummary.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::SageMaker::Model::EndpointSummary::GetCreationTime ( ) const
inline

A timestamp that shows when the endpoint was created.

Definition at line 127 of file EndpointSummary.h.

◆ GetEndpointArn()

const Aws::String& Aws::SageMaker::Model::EndpointSummary::GetEndpointArn ( ) const
inline

The Amazon Resource Name (ARN) of the endpoint.

Definition at line 86 of file EndpointSummary.h.

◆ GetEndpointName()

const Aws::String& Aws::SageMaker::Model::EndpointSummary::GetEndpointName ( ) const
inline

The name of the endpoint.

Definition at line 45 of file EndpointSummary.h.

◆ GetEndpointStatus()

const EndpointStatus& Aws::SageMaker::Model::EndpointSummary::GetEndpointStatus ( ) const
inline

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

Definition at line 212 of file EndpointSummary.h.

◆ GetLastModifiedTime()

const Aws::Utils::DateTime& Aws::SageMaker::Model::EndpointSummary::GetLastModifiedTime ( ) const
inline

A timestamp that shows when the endpoint was last modified.

Definition at line 158 of file EndpointSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::EndpointSummary::Jsonize ( ) const

◆ LastModifiedTimeHasBeenSet()

bool Aws::SageMaker::Model::EndpointSummary::LastModifiedTimeHasBeenSet ( ) const
inline

A timestamp that shows when the endpoint was last modified.

Definition at line 163 of file EndpointSummary.h.

◆ operator=()

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCreationTime() [1/2]

void Aws::SageMaker::Model::EndpointSummary::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the endpoint was created.

Definition at line 142 of file EndpointSummary.h.

◆ SetCreationTime() [2/2]

void Aws::SageMaker::Model::EndpointSummary::SetCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the endpoint was created.

Definition at line 137 of file EndpointSummary.h.

◆ SetEndpointArn() [1/3]

void Aws::SageMaker::Model::EndpointSummary::SetEndpointArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the endpoint.

Definition at line 101 of file EndpointSummary.h.

◆ SetEndpointArn() [2/3]

void Aws::SageMaker::Model::EndpointSummary::SetEndpointArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the endpoint.

Definition at line 96 of file EndpointSummary.h.

◆ SetEndpointArn() [3/3]

void Aws::SageMaker::Model::EndpointSummary::SetEndpointArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the endpoint.

Definition at line 106 of file EndpointSummary.h.

◆ SetEndpointName() [1/3]

void Aws::SageMaker::Model::EndpointSummary::SetEndpointName ( Aws::String &&  value)
inline

The name of the endpoint.

Definition at line 60 of file EndpointSummary.h.

◆ SetEndpointName() [2/3]

void Aws::SageMaker::Model::EndpointSummary::SetEndpointName ( const Aws::String value)
inline

The name of the endpoint.

Definition at line 55 of file EndpointSummary.h.

◆ SetEndpointName() [3/3]

void Aws::SageMaker::Model::EndpointSummary::SetEndpointName ( const char *  value)
inline

The name of the endpoint.

Definition at line 65 of file EndpointSummary.h.

◆ SetEndpointStatus() [1/2]

void Aws::SageMaker::Model::EndpointSummary::SetEndpointStatus ( const EndpointStatus value)
inline

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

Definition at line 268 of file EndpointSummary.h.

◆ SetEndpointStatus() [2/2]

void Aws::SageMaker::Model::EndpointSummary::SetEndpointStatus ( EndpointStatus &&  value)
inline

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

Definition at line 296 of file EndpointSummary.h.

◆ SetLastModifiedTime() [1/2]

void Aws::SageMaker::Model::EndpointSummary::SetLastModifiedTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the endpoint was last modified.

Definition at line 173 of file EndpointSummary.h.

◆ SetLastModifiedTime() [2/2]

void Aws::SageMaker::Model::EndpointSummary::SetLastModifiedTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the endpoint was last modified.

Definition at line 168 of file EndpointSummary.h.

◆ WithCreationTime() [1/2]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the endpoint was created.

Definition at line 152 of file EndpointSummary.h.

◆ WithCreationTime() [2/2]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the endpoint was created.

Definition at line 147 of file EndpointSummary.h.

◆ WithEndpointArn() [1/3]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithEndpointArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the endpoint.

Definition at line 116 of file EndpointSummary.h.

◆ WithEndpointArn() [2/3]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithEndpointArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the endpoint.

Definition at line 111 of file EndpointSummary.h.

◆ WithEndpointArn() [3/3]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithEndpointArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the endpoint.

Definition at line 121 of file EndpointSummary.h.

◆ WithEndpointName() [1/3]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithEndpointName ( Aws::String &&  value)
inline

The name of the endpoint.

Definition at line 75 of file EndpointSummary.h.

◆ WithEndpointName() [2/3]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithEndpointName ( const Aws::String value)
inline

The name of the endpoint.

Definition at line 70 of file EndpointSummary.h.

◆ WithEndpointName() [3/3]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithEndpointName ( const char *  value)
inline

The name of the endpoint.

Definition at line 80 of file EndpointSummary.h.

◆ WithEndpointStatus() [1/2]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithEndpointStatus ( const EndpointStatus value)
inline

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

Definition at line 324 of file EndpointSummary.h.

◆ WithEndpointStatus() [2/2]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithEndpointStatus ( EndpointStatus &&  value)
inline

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.

  • Creating: CreateEndpoint is executing.

  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

  • InService: Endpoint is available to process incoming requests.

  • Deleting: DeleteEndpoint is executing.

  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

Definition at line 352 of file EndpointSummary.h.

◆ WithLastModifiedTime() [1/2]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithLastModifiedTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that shows when the endpoint was last modified.

Definition at line 183 of file EndpointSummary.h.

◆ WithLastModifiedTime() [2/2]

EndpointSummary& Aws::SageMaker::Model::EndpointSummary::WithLastModifiedTime ( const Aws::Utils::DateTime value)
inline

A timestamp that shows when the endpoint was last modified.

Definition at line 178 of file EndpointSummary.h.


The documentation for this class was generated from the following file: