SageMaker / Paginator / ListClusterExtensions

ListClusterExtensions

class SageMaker.Paginator.ListClusterExtensions

paginator = client.get_paginator('list_cluster_extensions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_cluster_extensions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterArn='string',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ClusterArn (string) –

  [REQUIRED]

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

• 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

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)
        },
    ],

}

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.