[ aws . pricing-plan-manager ]

get-subscription

Description

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

Synopsis

  get-subscription
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--arn (string) [required]

The ARN of the subscription to retrieve.

Constraints:

• min: 1
• max: 2048

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream
• off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

subscription -> (structure)

The details of the requested subscription.

arn -> (string) [required]

The Amazon Resource Name (ARN) that uniquely identifies this subscription.

Constraints:

• min: 1
• max: 2048

planFamily -> (string) [required]

The pricing plan family for the subscription, such as CloudFront .

planTier -> (string) [required]

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) [required]

The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).

Possible values:

• DOWNGRADE
• CANCELLATION

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) [required]

The current status of the subscription. For the list of possible values, see the Status type.

Possible values:

• PENDING_APPROVAL
• ACTIVE
• SYNC_IN_PROGRESS
• FAILED

statusReason -> (string)

A human-readable explanation of the current status, present when additional context is available.

resourceArns -> (list) [required]

The ARNs of the AWS resources covered by this subscription.

Constraints:

• min: 1
• max: 10

(string)

createdAt -> (timestamp) [required]

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

updatedAt -> (timestamp) [required]

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.