PricingPlanManager

2026/07/30 - PricingPlanManager - 9 new api methods

Changes  Adds support for Public PricingPlanManager SDK

AssociateResourcesToSubscription (new) Link ¶

Adds one or more resources to an existing subscription. The subscription must be in an active state that is not pending other changes.

See also: AWS API Documentation

Request Syntax

client.associate_resources_to_subscription(
    arn='string',
    resourceArns=[
        'string',
    ],
    ifMatch='string',
    clientToken='string'
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the subscription to add resources to.

type resourceArns:

list

param resourceArns:

[REQUIRED]

The ARNs of the resources to add to the subscription.

  • (string) --

type ifMatch:

string

param ifMatch:

[REQUIRED]

The ETag value from a previous GetSubscription or ListSubscriptions response.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        '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'
}

Response Structure

  • (dict) --

    • subscription (dict) --

      The details of the subscription with the newly added resources.

      • 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, such as FREE, PRO, BUSINESS, or PREMIUM.

      • usageLevel (string) --

        The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      • scheduledChange (dict) --

        A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

        • 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. For the list of possible values, see the Status type.

      • 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 updated entity tag for concurrency control.

ApprovePaidSubscription (new) Link ¶

Approves a subscription that is in PENDING_APPROVAL status, activating it and starting billing.

See also: AWS API Documentation

Request Syntax

client.approve_paid_subscription(
    arn='string',
    ifMatch='string',
    clientToken='string'
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the subscription to approve.

type ifMatch:

string

param ifMatch:

[REQUIRED]

The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are approving the expected version of the subscription.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        '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'
}

Response Structure

  • (dict) --

    • subscription (dict) --

      The details of the approved subscription.

      • 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, such as FREE, PRO, BUSINESS, or PREMIUM.

      • usageLevel (string) --

        The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      • scheduledChange (dict) --

        A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

        • 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. For the list of possible values, see the Status type.

      • 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 updated entity tag for concurrency control.

CancelSubscriptionChange (new) Link ¶

Cancels a pending scheduled change on a subscription, such as a pending downgrade or cancellation. The subscription returns to its state before the change was scheduled.

See also: AWS API Documentation

Request Syntax

client.cancel_subscription_change(
    arn='string',
    ifMatch='string',
    clientToken='string'
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the subscription whose pending change you want to cancel.

type ifMatch:

string

param ifMatch:

[REQUIRED]

The ETag value from a previous GetSubscription or ListSubscriptions response.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        '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'
}

Response Structure

  • (dict) --

    • subscription (dict) --

      The details of the subscription with the pending change removed.

      • 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, such as FREE, PRO, BUSINESS, or PREMIUM.

      • usageLevel (string) --

        The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      • scheduledChange (dict) --

        A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

        • 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. For the list of possible values, see the Status type.

      • 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 updated entity tag for concurrency control.

CancelSubscription (new) Link ¶

Cancels a flat-rate pricing subscription.

See also: AWS API Documentation

Request Syntax

client.cancel_subscription(
    arn='string',
    ifMatch='string',
    clientToken='string'
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the subscription to cancel.

type ifMatch:

string

param ifMatch:

[REQUIRED]

The ETag value from a previous GetSubscription or ListSubscriptions response.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        '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'
}

Response Structure

  • (dict) --

    • subscription (dict) --

      The details of the subscription with the pending cancellation. For active subscriptions, a scheduledChange of type CANCELLATION is included.

      • 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, such as FREE, PRO, BUSINESS, or PREMIUM.

      • usageLevel (string) --

        The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      • scheduledChange (dict) --

        A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

        • 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. For the list of possible values, see the Status type.

      • 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 updated entity tag for concurrency control.

DisassociateResourcesFromSubscription (new) Link ¶

Removes one or more resources from an existing subscription.

See also: AWS API Documentation

Request Syntax

client.disassociate_resources_from_subscription(
    arn='string',
    resourceArns=[
        'string',
    ],
    ifMatch='string',
    clientToken='string'
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the subscription to remove resources from.

type resourceArns:

list

param resourceArns:

[REQUIRED]

The ARNs of the resources to remove from the subscription. For subscriptions in the CloudFront plan family, you cannot remove the required CloudFront distribution or WAF web ACL.

  • (string) --

type ifMatch:

string

param ifMatch:

[REQUIRED]

The ETag value from a previous GetSubscription or ListSubscriptions response.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        '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'
}

Response Structure

  • (dict) --

    • subscription (dict) --

      The details of the subscription with the specified resources removed.

      • 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, such as FREE, PRO, BUSINESS, or PREMIUM.

      • usageLevel (string) --

        The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      • scheduledChange (dict) --

        A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

        • 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. For the list of possible values, see the Status type.

      • 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 updated entity tag for concurrency control.

ListSubscriptions (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_subscriptions(
    nextToken='string'
)
type nextToken:

string

param nextToken:

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.

rtype:

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.

GetSubscription (new) Link ¶

Returns the details of a flat-rate pricing subscription, including its current status, associated resources, and any pending scheduled changes.

See also: AWS API Documentation

Request Syntax

client.get_subscription(
    arn='string'
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the subscription to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        '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'
}

Response Structure

  • (dict) --

    • subscription (dict) --

      The details of the requested subscription.

      • 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, such as FREE, PRO, BUSINESS, or PREMIUM.

      • usageLevel (string) --

        The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      • scheduledChange (dict) --

        A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

        • 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. For the list of possible values, see the Status type.

      • 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. Use this value in the If-Match header for subsequent operations on this subscription.

UpdateSubscription (new) Link ¶

Changes the plan tier of an existing subscription.

See also: AWS API Documentation

Request Syntax

client.update_subscription(
    arn='string',
    planTier='string',
    usageLevel='string',
    ifMatch='string',
    clientToken='string'
)
type arn:

string

param arn:

[REQUIRED]

The ARN of the subscription to update.

type planTier:

string

param planTier:

[REQUIRED]

The new tier level for the subscription.

type usageLevel:

string

param usageLevel:

The usage level within the plan tier. Specify DEFAULT for the base configuration. If omitted, the usage level is reset to the default.

type ifMatch:

string

param ifMatch:

[REQUIRED]

The ETag value from a previous GetSubscription or ListSubscriptions response. This ensures you are updating the expected version of the subscription.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the request is handled only once.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        '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'
}

Response Structure

  • (dict) --

    • subscription (dict) --

      The details of the updated subscription. For downgrades, the current tier remains unchanged and a scheduledChange indicates the pending change.

      • 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, such as FREE, PRO, BUSINESS, or PREMIUM.

      • usageLevel (string) --

        The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      • scheduledChange (dict) --

        A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

        • 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. For the list of possible values, see the Status type.

      • 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 updated entity tag for concurrency control.

CreateSubscription (new) Link ¶

Creates a flat-rate pricing subscription for the specified resources.

See also: AWS API Documentation

Request Syntax

client.create_subscription(
    planFamily='string',
    planTier='string',
    usageLevel='string',
    resourceArns=[
        'string',
    ],
    approvalMode='MANUAL'|'IMMEDIATE',
    clientToken='string'
)
type planFamily:

string

param planFamily:

[REQUIRED]

The pricing plan family to subscribe to, such as CloudFront.

type planTier:

string

param planTier:

[REQUIRED]

The tier level for the subscription, such as FREE, PRO, BUSINESS, or PREMIUM.

type usageLevel:

string

param usageLevel:

The usage level within the plan tier. Specify DEFAULT for the base configuration, or a higher level if your plan tier supports it.

type resourceArns:

list

param resourceArns:

[REQUIRED]

The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.

  • (string) --

type approvalMode:

string

param approvalMode:

Determines whether the subscription requires explicit approval before billing starts. Set to MANUAL to require a separate ApprovePaidSubscription call, or IMMEDIATE to activate the subscription right away. Defaults to IMMEDIATE if not specified.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'subscription': {
        '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'
}

Response Structure

  • (dict) --

    • subscription (dict) --

      The details of the newly created subscription.

      • 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, such as FREE, PRO, BUSINESS, or PREMIUM.

      • usageLevel (string) --

        The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      • scheduledChange (dict) --

        A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

        • 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. For the list of possible values, see the Status type.

      • 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. Use this value in the If-Match header for subsequent operations on this subscription.