SageMaker / Client / list_cluster_extensions

list_cluster_extensions

SageMaker.Client.list_cluster_extensions(**kwargs)

Lists the extensions installed on a SageMaker HyperPod cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_cluster_extensions(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1)
)
Parameters:

  • ClusterArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster whose extensions you want to list.

  • MaxResults (integer) – The maximum number of extensions to return in the response. If you don’t specify a value, SageMaker HyperPod returns up to 100 extensions.

  • NextToken (string) – If the result of the previous ListClusterExtensions request was truncated, the response includes a NextToken. To retrieve the next set of extensions, use the token in the next request. When you use the CreationTimeAfter or CreationTimeBefore filters, a response can contain fewer extensions than MaxResults, or none, and still include a NextToken. Continue until the response doesn’t include a NextToken.

  • CreationTimeAfter (datetime) – A filter that returns extensions created at or after the specified time. Timestamps are formatted according to the ISO 8601 standard.

  • CreationTimeBefore (datetime) – A filter that returns extensions created at or before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter.

Return type:

dict

Returns:

Response Syntax

{
    'Extensions': [
        {
            'ExtensionArn': 'string',
            'ExtensionName': 'string',
            'ExtensionVersion': 'string',
            'Status': 'Creating'|'Active'|'CreateFailed'|'Updating'|'Deleting'|'DeleteFailed'|'Degraded'|'UpdateFailed',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Extensions (list) –

      The list of extensions installed on the cluster.

      • (dict) –

        A summary of an extension installed on a SageMaker HyperPod cluster.

        • ExtensionArn (string) –

          The Amazon Resource Name (ARN) of the extension.

        • ExtensionName (string) –

          The name of the extension.

        • ExtensionVersion (string) –

          The version of the extension.

        • Status (string) –

          The status of the extension. For the meaning of each status, see ExtensionDetails.

        • CreationTime (datetime) –

          The time when the extension was created.

    • NextToken (string) –

      The next token specified for listing extensions on a SageMaker HyperPod cluster.

Exceptions