NetworkSecurityManagerCustomerAPI / Paginator / ListDeployments

ListDeployments¶

class NetworkSecurityManagerCustomerAPI.Paginator.ListDeployments¶

paginator = client.get_paginator('list_deployments')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    status='ACTIVE'|'DRAFT'|'DISABLED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

status (string) – Filters the results by status: ACTIVE, DRAFT, or DISABLED.
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': [
        {
            'deploymentId': 'string',
            'deploymentArn': 'string',
            'deploymentName': 'string',
            'status': 'DRAFT'|'ACTIVE'|'DISABLED',
            'version': 'string',
            'hasPublishedVersion': True|False,
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- deployments (list) –
  
  The list of deployments.
  - (dict) –
    
    Summary information about a deployment.
    - deploymentId (string) –
      
      The service-generated id of the deployment.
    - deploymentArn (string) –
      
      The Amazon Resource Name (ARN) of the deployment.
    - deploymentName (string) –
      
      The name of the deployment.
    - status (string) –
      
      The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).
    - version (string) –
      
      The version of the resource.
    - hasPublishedVersion (boolean) –
      
      Specifies whether a published version of the resource exists.
    - updatedAt (datetime) –
      
      The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
- NextToken (string) –
  
  A token to resume pagination.