[ 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 | --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]
Options¶
--catalog (string) [required]
The catalog identifier that specifies which benefit catalog to query.
Constraints:
- pattern:
[A-Za-z0-9_-]+
--identifier (string) [required]
The unique identifier of the benefit allocation to retrieve.
Constraints:
- pattern:
(arn:.+|benalloc-[0-9a-z]{14})
--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
--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.
Output¶
Id -> (string)
The unique identifier of the benefit allocation.
Constraints:
- pattern:
benalloc-[0-9a-z]{14}
Catalog -> (string)
The catalog identifier that the benefit allocation belongs to.
Constraints:
- pattern:
[A-Za-z0-9_-]+
Arn -> (string)
The Amazon Resource Name (ARN) of the benefit allocation.
Constraints:
- pattern:
(arn:.+benalloc-[0-9a-z]{14})
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).
Possible values:
ACTIVEINACTIVEFULFILLED
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.
Constraints:
- pattern:
benappl-[0-9a-z]{14}
BenefitId -> (string)
The identifier of the benefit that this allocation is based on.
Constraints:
- pattern:
(arn:.+|ben-[0-9a-z]{14})
FulfillmentType -> (string)
The fulfillment type used for this benefit allocation.
Possible values:
CREDITSCASHACCESS
ApplicableBenefitIds -> (list)
A list of benefit identifiers that this allocation can be applied to.
(string)
Constraints:
- pattern:
(arn:.+|ben-[0-9a-z]{14})
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) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARIssuanceDetails -> (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) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARIssuedAt -> (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) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARRemainingAmount -> (structure)
The remaining amount of the consumable benefit that is still available for use.
Amount -> (string) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARUtilizedAmount -> (structure)
The amount of the consumable benefit that has already been used.
Amount -> (string) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARIssuanceDetails -> (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) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARIssuedAt -> (timestamp)
The timestamp when this specific issuance was processed.CreditDetails -> (structure)
Details about credit-based fulfillment, if applicable to this benefit allocation.
AllocatedAmount -> (structure) [required]
The total amount of credits that have been allocated for this benefit.
Amount -> (string) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARIssuedAmount -> (structure) [required]
The amount of credits that have actually been issued and are available for use.
Amount -> (string) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARCodes -> (list) [required]
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) [required]
The AWS account ID that the credit code is associated with or can be applied to.Value -> (structure) [required]
The monetary value of the credit code.
Amount -> (string) [required]
The numeric amount of the monetary value.CurrencyCode -> (string) [required]
The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
Possible values:
AEDAMDARSAUDAWGAZNBBDBDTBGNBMDBNDBOBBRLBSDBYRBZDCADCHFCLPCNYCOPCRCCZKDKKDOPEEKEGPEURGBPGELGHSGTQGYDHKDHNLHRKHTGHUFIDRILSINRISKJMDJPYKESKHRKRWKYDKZTLBPLKRLTLLVLMADMNTMOPMURMVRMXNMYRNADNGNNIONOKNZDPABPENPHPPKRPLNPYGQARRONRUBSARSEKSGDSITSKKTHBTNDTRYTTDTWDTZSUAHUSDUYUUZSVNDXAFXCDXOFXPFZARAwsCreditCode -> (string) [required]
The actual credit code string that can be redeemed in the AWS billing console.Status -> (string) [required]
The current status of the credit code (e.g., active, redeemed, expired).
Possible values:
ACTIVEINACTIVEFULFILLEDIssuedAt -> (timestamp) [required]
The timestamp when the credit code was issued.ExpiresAt -> (timestamp) [required]
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.