[ aws . sagemaker ]

describe-resource-associations

Description

Returns the resources in your account that are associated with a SageMaker Capacity Reservation and the status of each association. Resources include SageMaker AI HyperPod clusters and SageMaker AI endpoints.

See also: AWS API Documentation

describe-resource-associations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ResourceAssociations

Synopsis

  describe-resource-associations
--sm-capacity-reservation-arn <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--sm-capacity-reservation-arn (string) [required]

The Amazon Resource Name (ARN) of the SageMaker Capacity Reservation. The ARN has the format arn:aws:sagemaker:region:account-id:sm-capacity-reservation/smcr-id .

Constraints:

  • min: 1
  • max: 256
  • pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]+:[0-9]{12}:sm-capacity-reservation/smcr-[0-9a-z]{12}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

SMCapacityReservationArn -> (string)

The Amazon Resource Name (ARN) of the SageMaker Capacity Reservation.

Constraints:

  • min: 1
  • max: 256
  • pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]+:[0-9]{12}:sm-capacity-reservation/smcr-[0-9a-z]{12}

SMCapacityReservationId -> (string)

The ID of the SageMaker Capacity Reservation. The ID is the last part of the ARN and starts with smcr- .

Constraints:

  • pattern: smcr-[0-9a-z]{12}

ResourceAssociations -> (list)

The associations between resources in your account and the SageMaker Capacity Reservation. The list is empty when your account has no associations with the reservation.

(tagged union structure)

An association between one type of resource in your account and a SageMaker Capacity Reservation. Each item contains exactly one member.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: HyperPodClusters, Endpoints.

HyperPodClusters -> (structure)

The association between the SageMaker AI HyperPod clusters in your account and the SageMaker Capacity Reservation. The association applies to all HyperPod clusters in your account.

Status -> (string) [required]

The status of the association. Valid values:

Pending

SageMaker AI is adding or removing the association.

Active

The resources are associated with the SageMaker Capacity Reservation and can use its instances.

Inactive

The resources are not associated with the SageMaker Capacity Reservation.

Possible values:

  • Pending
  • Active
  • Inactive

FailureReason -> (string)

The reason that the most recent attempt to add or remove the association failed. This value is returned only when the most recent attempt failed. After a failure to add the association, the status is Inactive . After a failure to remove the association, the status is Active .

Constraints:

  • min: 0
  • max: 1024

AssociatedTime -> (timestamp) [required]

The time when SageMaker AI started the current association. This time resets when you add the association again after it was removed or after it failed.

Endpoints -> (structure)

The association between the SageMaker AI endpoints in your account and the SageMaker Capacity Reservation, through one ML capacity reservation. The response includes one item for each ML capacity reservation.

MlReservationId -> (string)

The name of the ML capacity reservation. The name is the last part of the ML capacity reservation ARN.

Status -> (string) [required]

The status of the association. Valid values:

Pending

SageMaker AI is adding or removing the association.

Active

The resources are associated with the SageMaker Capacity Reservation and can use its instances.

Inactive

The resources are not associated with the SageMaker Capacity Reservation.

Possible values:

  • Pending
  • Active
  • Inactive

MatchCriteria -> (string)

How endpoints in your account match the ML capacity reservation. Valid values:

Open

Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don’t specify the ML capacity reservation ARN when you create the endpoint.

Targeted

An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.

Possible values:

  • Open
  • Targeted

EndpointSharing -> (string)

Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:

SingleEndpoint

Only one endpoint can use the ML capacity reservation.

MultipleEndpoints

Multiple endpoints can use the ML capacity reservation.

Possible values:

  • SingleEndpoint
  • MultipleEndpoints

MlReservationArn -> (string)

The Amazon Resource Name (ARN) of the ML capacity reservation. Specify this ARN in CreateEndpointConfig to use the reserved instances for an endpoint. For a new ML capacity reservation, this value is returned when the status is Active .

Constraints:

  • min: 20
  • max: 258
  • pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z0-9\-]{1,14}/.*

FailureReason -> (string)

The reason that the most recent attempt to add or remove the association failed. This value is returned only when the most recent attempt failed. After a failure to add the association, the status is Inactive . After a failure to remove the association, the status is Active .

Constraints:

  • min: 0
  • max: 1024

AssociatedTime -> (timestamp) [required]

The time when SageMaker AI started the current association. This time resets when you add the association again after it was removed or after it failed.

NextToken -> (string)

If the response is truncated, SageMaker AI returns this token. To retrieve the next set of results, use this token in your next request.

Constraints:

  • min: 0
  • max: 8192
  • pattern: .*