SageMaker / Client / list_ai_workload_configs

list_ai_workload_configs

SageMaker.Client.list_ai_workload_configs(**kwargs)

Returns a list of AI workload configurations in your account. You can filter the results by name and creation time, and sort the results. The response is paginated.

See also: AWS API Documentation

Request Syntax

response = client.list_ai_workload_configs(
    MaxResults=123,
    NextToken='string',
    NameContains='string',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending'
)
Parameters:

  • MaxResults (integer) – The maximum number of AI workload configurations to return in the response.

  • NextToken (string) – If the previous call to ListAIWorkloadConfigs didn’t return the full set of configurations, the call returns a token for getting the next set of configurations.

  • NameContains (string) – A string in the configuration name. This filter returns only configurations whose name contains the specified string.

  • CreationTimeAfter (datetime) – A filter that returns only configurations created after the specified time.

  • CreationTimeBefore (datetime) – A filter that returns only configurations created before the specified time.

  • SortBy (string) – The field to sort results by. The default is CreationTime.

  • SortOrder (string) – The sort order for results. The default is Descending.

Return type:

dict

Returns:

Response Syntax

{
    'AIWorkloadConfigs': [
        {
            'AIWorkloadConfigName': 'string',
            'AIWorkloadConfigArn': 'string',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AIWorkloadConfigs (list) –

      An array of AIWorkloadConfigSummary objects, one for each AI workload configuration that matches the specified filters.

      • (dict) –

        Summary information about an AI workload configuration.

        • AIWorkloadConfigName (string) –

          The name of the AI workload configuration.

        • AIWorkloadConfigArn (string) –

          The Amazon Resource Name (ARN) of the AI workload configuration.

        • CreationTime (datetime) –

          A timestamp that indicates when the configuration was created.

    • NextToken (string) –

      If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of configurations, use it in the subsequent request.