AWS CLI Command Reference

[ aws . endusermessaging ]

create-brand-profile-attributes

Description

Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.

See also: AWS API Documentation

Synopsis

  create-brand-profile-attributes
--brand-profile-id <value>
--attributes <value>
[--client-token <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

--brand-profile-id (string) [required]

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9_:/-]+

--attributes (list) [required]

The brand profile attributes.

Constraints:

  • min: 1
  • max: 10

(structure)

Specifies an attribute to create for a brand profile.

attributeName -> (string) [required]

The name of the brand profile attribute. The name is unique within a brand profile.

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9_ -]*[A-Za-z0-9_-][A-Za-z0-9_ -]*

attributeType -> (string) [required]

The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

Possible values:

  • TEXT
  • IMAGE
  • DOCUMENT

attributeValue -> (string)

The text value for the attribute. This value applies to attributes of type TEXT. For attributes of type IMAGE or DOCUMENT, provide the media through the attachment body instead.

Constraints:

  • min: 0
  • max: 4096

attachmentBody -> (blob)

The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.

Constraints:

  • min: 1
  • max: 5242880

description -> (string)

A description of the attribute.

Constraints:

  • min: 0
  • max: 1024

category -> (string)

The category of the attribute.

Constraints:

  • min: 1
  • max: 64

Shorthand Syntax:

attributeName=string,attributeType=string,attributeValue=string,attachmentBody=blob,description=string,category=string ...

JSON Syntax:

[
  {
    "attributeName": "string",
    "attributeType": "TEXT"|"IMAGE"|"DOCUMENT",
    "attributeValue": "string",
    "attachmentBody": blob,
    "description": "string",
    "category": "string"
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

Constraints:

  • min: 1
  • max: 128
  • pattern: [\x21-\x7E]+

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

attributes -> (list)

The brand profile attributes.

Constraints:

  • min: 1
  • max: 10

(structure)

Contains information about an attribute that was created for a brand profile.

attributeName -> (string) [required]

The name of the brand profile attribute. The name is unique within a brand profile.

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9_ -]*[A-Za-z0-9_-][A-Za-z0-9_ -]*

attributeType -> (string) [required]

The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

Possible values:

  • TEXT
  • IMAGE
  • DOCUMENT

mediaDownloadUrl -> (string)

A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.

Constraints:

  • min: 1
  • max: 4096
© Copyright 2026, Amazon Web Services. Created using Sphinx.