describe_pipeline

describe_pipeline(**kwargs)

Describes the details of a pipeline.

See also: AWS API Documentation

Request Syntax

response = client.describe_pipeline(
    PipelineName='string'
)

Parameters

PipelineName (string) --

[REQUIRED]

The name of the pipeline to describe.

Return type

dict

Returns

Response Syntax

{
    'PipelineArn': 'string',
    'PipelineName': 'string',
    'PipelineDisplayName': 'string',
    'PipelineDefinition': 'string',
    'PipelineDescription': 'string',
    'RoleArn': 'string',
    'PipelineStatus': 'Active',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastRunTime': datetime(2015, 1, 1),
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string'
    },
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string'
    },
    'ParallelismConfiguration': {
        'MaxParallelExecutionSteps': 123
    }
}

Response Structure

• (dict) --
  • PipelineArn (string) --

    The Amazon Resource Name (ARN) of the pipeline.

  • PipelineName (string) --

    The name of the pipeline.

  • PipelineDisplayName (string) --

    The display name of the pipeline.

  • PipelineDefinition (string) --

    The JSON pipeline definition.

  • PipelineDescription (string) --

    The description of the pipeline.

  • RoleArn (string) --

    The Amazon Resource Name (ARN) that the pipeline uses to execute.

  • PipelineStatus (string) --

    The status of the pipeline execution.

  • CreationTime (datetime) --

    The time when the pipeline was created.

  • LastModifiedTime (datetime) --

    The time when the pipeline was last modified.

  • LastRunTime (datetime) --

    The time when the pipeline was last run.

  • CreatedBy (dict) --

    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

    • UserProfileArn (string) --

      The Amazon Resource Name (ARN) of the user's profile.

    • UserProfileName (string) --

      The name of the user's profile.

    • DomainId (string) --

      The domain associated with the user.

  • LastModifiedBy (dict) --

    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

    • UserProfileArn (string) --

      The Amazon Resource Name (ARN) of the user's profile.

    • UserProfileName (string) --

      The name of the user's profile.

    • DomainId (string) --

      The domain associated with the user.

  • ParallelismConfiguration (dict) --

    Lists the parallelism configuration applied to the pipeline.

    • MaxParallelExecutionSteps (integer) --

      The max number of steps that can be executed in parallel.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound