SageMaker / Client / list_cluster_scheduler_configs

list_cluster_scheduler_configs#

SageMaker.Client.list_cluster_scheduler_configs(**kwargs)#

List the cluster policy configurations.

See also: AWS API Documentation

Request Syntax

response = client.list_cluster_scheduler_configs(
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    NameContains='string',
    ClusterArn='string',
    Status='Creating'|'CreateFailed'|'CreateRollbackFailed'|'Created'|'Updating'|'UpdateFailed'|'UpdateRollbackFailed'|'Updated'|'Deleting'|'DeleteFailed'|'DeleteRollbackFailed'|'Deleted',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • CreatedAfter (datetime) – Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

  • CreatedBefore (datetime) – Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

  • NameContains (string) – Filter for name containing this string.

  • ClusterArn (string) – Filter for ARN of the cluster.

  • Status (string) – Filter for status.

  • SortBy (string) – Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

  • SortOrder (string) – The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.

  • NextToken (string) – If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

  • MaxResults (integer) – The maximum number of cluster policies to list.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterSchedulerConfigSummaries': [
        {
            'ClusterSchedulerConfigArn': 'string',
            'ClusterSchedulerConfigId': 'string',
            'ClusterSchedulerConfigVersion': 123,
            'Name': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'Status': 'Creating'|'CreateFailed'|'CreateRollbackFailed'|'Created'|'Updating'|'UpdateFailed'|'UpdateRollbackFailed'|'Updated'|'Deleting'|'DeleteFailed'|'DeleteRollbackFailed'|'Deleted',
            'ClusterArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ClusterSchedulerConfigSummaries (list) –

      Summaries of the cluster policies.

      • (dict) –

        Summary of the cluster policy.

        • ClusterSchedulerConfigArn (string) –

          ARN of the cluster policy.

        • ClusterSchedulerConfigId (string) –

          ID of the cluster policy.

        • ClusterSchedulerConfigVersion (integer) –

          Version of the cluster policy.

        • Name (string) –

          Name of the cluster policy.

        • CreationTime (datetime) –

          Creation time of the cluster policy.

        • LastModifiedTime (datetime) –

          Last modified time of the cluster policy.

        • Status (string) –

          Status of the cluster policy.

        • ClusterArn (string) –

          ARN of the cluster.

    • NextToken (string) –

      If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.