SageMaker / Client / list_pipeline_parameters_for_execution

list_pipeline_parameters_for_execution#

SageMaker.Client.list_pipeline_parameters_for_execution(**kwargs)#

Gets a list of parameters for a pipeline execution.

See also: AWS API Documentation

Request Syntax

response = client.list_pipeline_parameters_for_execution(
    PipelineExecutionArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • PipelineExecutionArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the pipeline execution.

  • NextToken (string) – If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

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

Return type:

dict

Returns:

Response Syntax

{
    'PipelineParameters': [
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PipelineParameters (list) –

      Contains a list of pipeline parameters. This list can be empty.

      • (dict) –

        Assigns a value to a named Pipeline parameter.

        • Name (string) –

          The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

        • Value (string) –

          The literal value for the parameter.

    • NextToken (string) –

      If the result of the previous ListPipelineParametersForExecution request was truncated, the response includes a NextToken. To retrieve the next set of parameters, use the token in the next request.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound