PricingPlanManager / Paginator / ListSubscriptions

ListSubscriptions¶

class PricingPlanManager.Paginator.ListSubscriptions¶

paginator = client.get_paginator('list_subscriptions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from PricingPlanManager.Client.list_subscriptions().

Request Syntax

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

Parameters:

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.
StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'subscriptionSummaries': [
        {
            'arn': 'string',
            'planFamily': 'string',
            'planTier': 'string',
            'usageLevel': 'string',
            'scheduledChange': {
                'changeType': 'DOWNGRADE'|'CANCELLATION',
                'effectiveDate': datetime(2015, 1, 1),
                'planTier': 'string',
                'usageLevel': 'string'
            },
            'status': 'PENDING_APPROVAL'|'ACTIVE'|'SYNC_IN_PROGRESS'|'FAILED',
            'statusReason': 'string',
            'resourceArns': [
                'string',
            ],
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'eTag': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- subscriptionSummaries (list) –
  
  The list of subscription summaries for the calling account.
  - (dict) –
    
    Summary information for a flat-rate pricing subscription, as returned by list operations.
    - arn (string) –
      
      The Amazon Resource Name (ARN) that uniquely identifies this subscription.
    - planFamily (string) –
      
      The pricing plan family for the subscription, such as CloudFront.
    - planTier (string) –
      
      The current tier level of the pricing plan.
    - usageLevel (string) –
      
      The usage level within the plan tier.
    - scheduledChange (dict) –
      
      A pending change that will take effect at the end of the current billing period, if any.
      - changeType (string) –
        
        The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).
      - effectiveDate (datetime) –
        
        The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system.
      - planTier (string) –
        
        For downgrades, the tier level that the subscription will change to. Not present for cancellations.
      - usageLevel (string) –
        
        For downgrades, the target usage level after the change takes effect.
    - status (string) –
      
      The current status of the subscription.
    - statusReason (string) –
      
      A human-readable explanation of the current status, present when additional context is available.
    - resourceArns (list) –
      
      The ARNs of the AWS resources covered by this subscription.
      - (string) –
    - createdAt (datetime) –
      
      The date and time when the subscription was created, in ISO 8601 format.
    - updatedAt (datetime) –
      
      The date and time when the subscription was last modified, in ISO 8601 format.
    - eTag (string) –
      
      The entity tag for concurrency control. Pass this value in the If-Match header when making changes to this subscription.
- NextToken (string) –
  
  A token to resume pagination.