Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pricing-plan-manager ]

create-subscription

Description

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

Note

When approvalMode is set to MANUAL , paid-tier subscriptions are created in PENDING_APPROVAL status and require a separate ApprovePaidSubscription call before billing starts. Free-tier subscriptions are always activated immediately regardless of approval mode.

When approvalMode is set to IMMEDIATE or is not specified, the subscription is activated immediately.

See also: AWS API Documentation

Synopsis

  create-subscription
--plan-family <value>
--plan-tier <value>
[--usage-level <value>]
--resource-arns <value>
[--approval-mode <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--plan-family (string)

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

--plan-tier (string)

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

--usage-level (string)

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

--resource-arns (list)

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

Note

For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.

(string)

Syntax:

"string" "string" ...

--approval-mode (string)

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.

Possible values:

• MANUAL
• IMMEDIATE

--client-token (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

subscription -> (structure)

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 -> (structure)

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 -> (timestamp)

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 -> (timestamp)

The date and time when the subscription was created, in ISO 8601 format.

updatedAt -> (timestamp)

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.