AWS CLI Command Reference

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 . partnercentral-benefits ]

get-benefit-allocation

Description

Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

See also: AWS API Documentation

Synopsis

  get-benefit-allocation
--catalog <value>
--identifier <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

--catalog (string)

The catalog identifier that specifies which benefit catalog to query.

--identifier (string)

The unique identifier of the benefit allocation to retrieve.

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

Id -> (string)

The unique identifier of the benefit allocation.

Catalog -> (string)

The catalog identifier that the benefit allocation belongs to.

Arn -> (string)

The Amazon Resource Name (ARN) of the benefit allocation.

Name -> (string)

The human-readable name of the benefit allocation.

Description -> (string)

A detailed description of the benefit allocation.

Status -> (string)

The current status of the benefit allocation (e.g., active, expired, consumed).

StatusReason -> (string)

Additional information explaining the current status of the benefit allocation.

BenefitApplicationId -> (string)

The identifier of the benefit application that resulted in this allocation.

BenefitId -> (string)

The identifier of the benefit that this allocation is based on.

FulfillmentType -> (string)

The fulfillment type used for this benefit allocation.

ApplicableBenefitIds -> (list)

A list of benefit identifiers that this allocation can be applied to.

(string)

FulfillmentDetail -> (tagged union structure)

Detailed information about how the benefit allocation is fulfilled.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DisbursementDetails, ConsumableDetails, CreditDetails, AccessDetails.

DisbursementDetails -> (structure)

Details about disbursement-based fulfillment, if applicable to this benefit allocation.

DisbursedAmount -> (structure)

The total amount that has been disbursed for this benefit allocation.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

IssuanceDetails -> (structure)

Detailed information about how the disbursement was issued and processed.

IssuanceId -> (string)

The unique identifier for this specific issuance.

IssuanceAmount -> (structure)

The monetary amount or value that was issued in this specific issuance.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

IssuedAt -> (timestamp)

The timestamp when this specific issuance was processed.

ConsumableDetails -> (structure)

Details about consumable-based fulfillment, if applicable to this benefit allocation.

AllocatedAmount -> (structure)

The total amount of the consumable benefit that has been allocated.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

RemainingAmount -> (structure)

The remaining amount of the consumable benefit that is still available for use.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

UtilizedAmount -> (structure)

The amount of the consumable benefit that has already been used.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

IssuanceDetails -> (structure)

Detailed information about how the consumable benefit was issued and distributed.

IssuanceId -> (string)

The unique identifier for this specific issuance.

IssuanceAmount -> (structure)

The monetary amount or value that was issued in this specific issuance.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

IssuedAt -> (timestamp)

The timestamp when this specific issuance was processed.

CreditDetails -> (structure)

Details about credit-based fulfillment, if applicable to this benefit allocation.

AllocatedAmount -> (structure)

The total amount of credits that have been allocated for this benefit.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

IssuedAmount -> (structure)

The amount of credits that have actually been issued and are available for use.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

Codes -> (list)

A list of credit codes that have been generated for this benefit allocation.

(structure)

Represents an AWS credit code that can be applied to an AWS account for billing purposes.

AwsAccountId -> (string)

The AWS account ID that the credit code is associated with or can be applied to.

Value -> (structure)

The monetary value of the credit code.

Amount -> (string)

The numeric amount of the monetary value.

CurrencyCode -> (string)

The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.

AwsCreditCode -> (string)

The actual credit code string that can be redeemed in the AWS billing console.

Status -> (string)

The current status of the credit code (e.g., active, redeemed, expired).

IssuedAt -> (timestamp)

The timestamp when the credit code was issued.

ExpiresAt -> (timestamp)

The timestamp when the credit code expires and can no longer be redeemed.

AccessDetails -> (structure)

Details about access-based fulfillment, if applicable to this benefit allocation.

Description -> (string)

A description of the access privileges or permissions granted by this benefit.

CreatedAt -> (timestamp)

The timestamp when the benefit allocation was created.

UpdatedAt -> (timestamp)

The timestamp when the benefit allocation was last updated.

StartsAt -> (timestamp)

The timestamp when the benefit allocation becomes active and usable.

ExpiresAt -> (timestamp)

The timestamp when the benefit allocation expires and is no longer usable.