AWS CLI Command Reference

[ aws . partnercentral-benefits ]

create-benefit-application

Description

Creates a new benefit application for a partner to request access to AWS benefits and programs.

See also: AWS API Documentation

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

  create-benefit-application
--catalog <value>
--client-token <value>
[--name <value>]
[--description <value>]
--benefit-identifier <value>
[--fulfillment-types <value>]
[--benefit-application-details <value>]
[--tags <value>]
[--associated-resources <value>]
[--partner-contacts <value>]
[--file-details <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 create the application in.

Constraints:

  • pattern: [A-Za-z0-9_-]+

--client-token (string) [required]

A unique, case-sensitive identifier to ensure idempotent processing of the creation request.

Constraints:

  • min: 1
  • max: 64
  • pattern: [!-~]{1,64}

--name (string)

A human-readable name for the benefit application.

Constraints:

  • min: 1
  • max: 255

--description (string)

A detailed description of the benefit application and its intended use.

Constraints:

  • min: 1
  • max: 1000

--benefit-identifier (string) [required]

The unique identifier of the benefit being requested in this application.

Constraints:

  • pattern: (arn:.+|ben-[0-9a-z]{14})

--fulfillment-types (list)

The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).

(string)

Possible values:

  • CREDITS
  • CASH
  • ACCESS

Syntax:

"string" "string" ...

--benefit-application-details (document)

Detailed information and requirements specific to the benefit being requested.

JSON Syntax:

{...}

--tags (list)

Key-value pairs to categorize and organize the benefit application.

Constraints:

  • min: 0
  • max: 200

(structure)

Represents a key-value pair used for categorizing and organizing AWS resources.

Key -> (string) [required]

The tag key, which acts as a category or label for the tag.

Constraints:

  • min: 1
  • max: 128
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value -> (string) [required]

The tag value, which provides additional information or context for the tag key.

Constraints:

  • min: 0
  • max: 256
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--associated-resources (list)

AWS resources that are associated with this benefit application.

Constraints:

  • min: 0
  • max: 10

(string)

Constraints:

  • pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.+)

Syntax:

"string" "string" ...

--partner-contacts (list)

Contact information for partner representatives responsible for this benefit application.

Constraints:

  • min: 0
  • max: 1

(structure)

Represents contact information for a partner representative.

Email -> (string)

The email address of the contact person.

Constraints:

  • min: 0
  • max: 80
  • pattern: [a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?

FirstName -> (string)

The first name of the contact person.

Constraints:

  • min: 0
  • max: 80

LastName -> (string)

The last name of the contact person.

Constraints:

  • min: 0
  • max: 80

BusinessTitle -> (string)

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

Constraints:

  • min: 0
  • max: 80

Phone -> (string)

The phone number of the contact person.

Shorthand Syntax:

Email=string,FirstName=string,LastName=string,BusinessTitle=string,Phone=string ...

JSON Syntax:

[
  {
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "BusinessTitle": "string",
    "Phone": "string"
  }
  ...
]

--file-details (list)

Supporting documents and files attached to the benefit application.

Constraints:

  • min: 0
  • max: 30

(structure)

Represents input information for uploading a file to a benefit application.

FileURI -> (string) [required]

The URI or location where the file should be stored or has been uploaded.

Constraints:

  • min: 1
  • max: 2000
  • pattern: (s3://|https://).*

BusinessUseCase -> (string)

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

Shorthand Syntax:

FileURI=string,BusinessUseCase=string ...

JSON Syntax:

[
  {
    "FileURI": "string",
    "BusinessUseCase": "string"
  }
  ...
]

--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 assigned to the newly created benefit application.

Constraints:

  • pattern: benappl-[0-9a-z]{14}

Arn -> (string)

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

Revision -> (string)

The initial revision number of the newly created benefit application.
© Copyright 2025, Amazon Web Services. Created using Sphinx.