SageMaker / Paginator / ListPipelineParametersForExecution

ListPipelineParametersForExecution

class SageMaker.Paginator.ListPipelineParametersForExecution

paginator = client.get_paginator('list_pipeline_parameters_for_execution')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_pipeline_parameters_for_execution().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PipelineExecutionArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• PipelineExecutionArn (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'PipelineParameters': [
        {
            'Name': 'string',
            'Value': '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.