SageMaker / Client / describe_reserved_capacity

describe_reserved_capacity

SageMaker.Client.describe_reserved_capacity(**kwargs)

Retrieves details about a reserved capacity.

See also: AWS API Documentation

Request Syntax

response = client.describe_reserved_capacity(
    ReservedCapacityArn='string'
)

Parameters:

ReservedCapacityArn (string) –

[REQUIRED]

ARN of the reserved capacity to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ReservedCapacityArn': 'string',
    'ReservedCapacityType': 'UltraServer'|'Instance',
    'Status': 'Pending'|'Active'|'Scheduled'|'Expired'|'Failed',
    'AvailabilityZone': 'string',
    'DurationHours': 123,
    'DurationMinutes': 123,
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'InstanceType': 'ml.p4d.24xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn1.32xlarge'|'ml.trn2.48xlarge'|'ml.p6-b200.48xlarge'|'ml.p4de.24xlarge'|'ml.p6e-gb200.36xlarge'|'ml.p5.4xlarge',
    'TotalInstanceCount': 123,
    'AvailableInstanceCount': 123,
    'InUseInstanceCount': 123,
    'UltraServerSummary': {
        'UltraServerType': 'string',
        'InstanceType': 'ml.p4d.24xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn1.32xlarge'|'ml.trn2.48xlarge'|'ml.p6-b200.48xlarge'|'ml.p4de.24xlarge'|'ml.p6e-gb200.36xlarge'|'ml.p5.4xlarge',
        'UltraServerCount': 123,
        'AvailableSpareInstanceCount': 123,
        'UnhealthyInstanceCount': 123
    }
}

Response Structure

• (dict) –

  • ReservedCapacityArn (string) –

    ARN of the reserved capacity.

  • ReservedCapacityType (string) –

    The type of reserved capacity.

  • Status (string) –

    The current status of the reserved capacity.

  • AvailabilityZone (string) –

    The Availability Zone where the reserved capacity is provisioned.

  • DurationHours (integer) –

    The total duration of the reserved capacity in hours.

  • DurationMinutes (integer) –

    The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.

  • StartTime (datetime) –

    The timestamp when the reserved capacity becomes active.

  • EndTime (datetime) –

    The timestamp when the reserved capacity expires.

  • InstanceType (string) –

    The Amazon EC2 instance type used in the reserved capacity.

  • TotalInstanceCount (integer) –

    The total number of instances allocated to this reserved capacity.

  • AvailableInstanceCount (integer) –

    The number of instances currently available for use in this reserved capacity.

  • InUseInstanceCount (integer) –

    The number of instances currently in use from this reserved capacity.

  • UltraServerSummary (dict) –

    A summary of the UltraServer associated with this reserved capacity.

    • UltraServerType (string) –

      The type of UltraServer, such as ml.u-p6e-gb200x72.

    • InstanceType (string) –

      The Amazon EC2 instance type used in the UltraServer.

    • UltraServerCount (integer) –

      The number of UltraServers of this type.

    • AvailableSpareInstanceCount (integer) –

      The number of available spare instances in the UltraServers.

    • UnhealthyInstanceCount (integer) –

      The total number of instances across all UltraServers of this type that are currently in an unhealthy state.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound