SageMaker / Client / describe_ai_workload_config

describe_ai_workload_config¶

SageMaker.Client.describe_ai_workload_config(**kwargs)¶

Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.

Request Syntax

response = client.describe_ai_workload_config(
    AIWorkloadConfigName='string'
)

Parameters:

AIWorkloadConfigName (string) –

[REQUIRED]

The name of the AI workload configuration to describe.

Return type:

dict

Returns:

Response Syntax

{
    'AIWorkloadConfigName': 'string',
    'AIWorkloadConfigArn': 'string',
    'DatasetConfig': {
        'InputDataConfig': [
            {
                'ChannelName': 'string',
                'DataSource': {
                    'S3DataSource': {
                        'S3Uri': 'string'
                    }
                }
            },
        ]
    },
    'AIWorkloadConfigs': {
        'WorkloadSpec': {
            'Inline': 'string'
        }
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- AIWorkloadConfigName (string) –
  
  The name of the AI workload configuration.
- AIWorkloadConfigArn (string) –
  
  The Amazon Resource Name (ARN) of the AI workload configuration.
- DatasetConfig (dict) –
  
  The dataset configuration for the workload.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: InputDataConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - InputDataConfig (list) –
    
    An array of input data channel configurations for the workload.
    - (dict) –
      
      A channel of input data for an AI workload configuration. Each channel has a name and a data source.
      - ChannelName (string) –
        
        The logical name for the data channel.
      - DataSource (dict) –
        
        The data source for this channel.
        
        S3DataSource (dict) –
        
        The Amazon S3 data source configuration.
        
        S3Uri (string) –
        
        The Amazon S3 URI of the data.
- AIWorkloadConfigs (dict) –
  
  The benchmark tool configuration and workload specification.
  - WorkloadSpec (dict) –
    
    The workload specification that defines benchmark parameters.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: Inline. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - Inline (string) –
      
      An inline YAML or JSON string that defines benchmark parameters.
- Tags (list) –
  
  The tags associated with the AI workload configuration.
  - (dict) –
    
    A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
    
    You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
    
    For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
    - Key (string) –
      
      The tag key. Tag keys must be unique per resource.
    - Value (string) –
      
      The tag value.
- CreationTime (datetime) –
  
  A timestamp that indicates when the AI workload configuration was created.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound