Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

ListDeployments

class GreengrassV2.Paginator.ListDeployments
paginator = client.get_paginator('list_deployments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GreengrassV2.Client.list_deployments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    targetArn='string',
    historyFilter='ALL'|'LATEST_ONLY',
    parentTargetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • targetArn (string) -- The ARN of the target IoT thing or thing group.
  • historyFilter (string) --

    The filter for the list of deployments. Choose one of the following options:

    • ALL – The list includes all deployments.
    • LATEST_ONLY – The list includes only the latest revision of each deployment.

    Default: LATEST_ONLY

  • parentTargetArn (string) -- The parent deployment's target ARN within a subdeployment.
  • 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

{
    'deployments': [
        {
            'targetArn': 'string',
            'revisionId': 'string',
            'deploymentId': 'string',
            'deploymentName': 'string',
            'creationTimestamp': datetime(2015, 1, 1),
            'deploymentStatus': 'ACTIVE'|'COMPLETED'|'CANCELED'|'FAILED'|'INACTIVE',
            'isLatestForTarget': True|False,
            'parentTargetArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • deployments (list) --

      A list that summarizes each deployment.

      • (dict) --

        Contains information about a deployment.

        • targetArn (string) --

          The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.

        • revisionId (string) --

          The revision number of the deployment.

        • deploymentId (string) --

          The ID of the deployment.

        • deploymentName (string) --

          The name of the deployment.

        • creationTimestamp (datetime) --

          The time at which the deployment was created, expressed in ISO 8601 format.

        • deploymentStatus (string) --

          The status of the deployment.

        • isLatestForTarget (boolean) --

          Whether or not the deployment is the latest revision for its target.

        • parentTargetArn (string) --

          The parent deployment's target ARN within a subdeployment.

    • NextToken (string) --

      A token to resume pagination.