PricingPlanManager / Client / list_subscriptions

list_subscriptions

PricingPlanManager.Client.list_subscriptions(**kwargs)

Returns a summary of all flat-rate pricing subscriptions in the calling account.

See also: AWS API Documentation

Request Syntax

response = client.list_subscriptions(
    nextToken='string'
)
Parameters:

nextToken (string) – A token from a previous ListSubscriptions response. If the response included a nextToken, there are more results available. Pass this value to retrieve the next page of results.

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 that indicates there are more results available. Pass this value in a subsequent ListSubscriptions request to retrieve the next page of results.

Exceptions