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

Description

Retrieves detailed information about a specific benefit application.

See also: AWS API Documentation

get-benefit-application uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  get-benefit-application
--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 application 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 application.

Arn -> (string)

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

Catalog -> (string)

The catalog identifier that the benefit application belongs to.

BenefitId -> (string)

The identifier of the benefit being requested in this application.

Name -> (string)

The human-readable name of the benefit application.

Description -> (string)

A detailed description of the benefit application.

FulfillmentTypes -> (list)

The fulfillment types requested for this benefit application.

(string)

BenefitApplicationDetails -> (document)

Detailed information and requirements specific to the benefit being requested.

Programs -> (list)

The AWS partner programs associated with this benefit application.

(string)

Status -> (string)

The current processing status of the benefit application.

Stage -> (string)

The current stage in the benefit application processing workflow.

StatusReason -> (string)

Additional information explaining the current status of the benefit application.

StatusReasonCode -> (string)

A standardized code representing the reason for the current status.

StatusReasonCodes -> (list)

The list of standardized codes representing the reason for the current status.

(string)

CreatedAt -> (timestamp)

The timestamp when the benefit application was created.

UpdatedAt -> (timestamp)

The timestamp when the benefit application was last updated.

Revision -> (string)

The current revision number of the benefit application.

AssociatedResources -> (list)

AWS resources that are associated with this benefit application.

(string)

PartnerContacts -> (list)

Contact information for partner representatives responsible for this benefit application.

(structure)

Represents contact information for a partner representative.

Email -> (string)

The email address of the contact person.

FirstName -> (string)

The first name of the contact person.

LastName -> (string)

The last name of the contact person.

BusinessTitle -> (string)

The business title or role of the contact person within the organization.

Phone -> (string)

The phone number of the contact person.

FileDetails -> (list)

Supporting documents and files attached to the benefit application.

(structure)

Represents detailed information about a file attached to a benefit application.

FileURI -> (string)

The URI or location where the file is stored.

BusinessUseCase -> (string)

The business purpose or use case that this file supports in the benefit application.

FileName -> (string)

The original name of the uploaded file.

FileStatus -> (string)

The current processing status of the file (e.g., uploaded, processing, approved, rejected).

FileStatusReason -> (string)

The reason for that particulat file status.

FileType -> (string)

The type or category of the file (e.g., document, image, spreadsheet).

CreatedBy -> (string)

The identifier of the user who uploaded the file.

CreatedAt -> (timestamp)

The timestamp when the file was uploaded.