AWS CLI Command Reference

[ aws . partnercentral-channel ]

create-channel-handshake

Description

Creates a new channel handshake request to establish a partnership with another AWS account.

See also: AWS API Documentation

Synopsis

  create-channel-handshake
--handshake-type <value>
--catalog <value>
--associated-resource-identifier <value>
[--payload <value>]
[--client-token <value>]
[--tags <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

--handshake-type (string) [required]

The type of handshake to create (e.g., start service period, revoke service period).

Possible values:

  • START_SERVICE_PERIOD
  • REVOKE_SERVICE_PERIOD
  • PROGRAM_MANAGEMENT_ACCOUNT

--catalog (string) [required]

The catalog identifier for the handshake request.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z]*

--associated-resource-identifier (string) [required]

The identifier of the resource associated with this handshake.

Constraints:

  • min: 16
  • max: 1011
  • pattern: ((arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/pma-[a-z0-9]{13}(/relationship/rs-[a-z0-9]{13})?)|(pma|rs)-[a-z0-9]{13})

--payload (tagged union structure)

The payload containing specific details for the handshake type.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: startServicePeriodPayload, revokeServicePeriodPayload.

startServicePeriodPayload -> (structure)

Payload for starting a service period handshake.

programManagementAccountIdentifier -> (string) [required]

The identifier of the program management account.

Constraints:

  • min: 17
  • max: 1011
  • pattern: (arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}

note -> (string)

A note providing additional information about the service period.

Constraints:

  • min: 1
  • max: 300
  • pattern: [^\x00-\x1F\x7F]*

servicePeriodType -> (string) [required]

The type of service period being started.

Possible values:

  • MINIMUM_NOTICE_PERIOD
  • FIXED_COMMITMENT_PERIOD

minimumNoticeDays -> (string)

The minimum number of days notice required for changes.

Constraints:

  • min: 1
  • max: 10
  • pattern: [0-9]*

endDate -> (timestamp)

The end date of the service period.

revokeServicePeriodPayload -> (structure)

Payload for revoking a service period handshake.

programManagementAccountIdentifier -> (string) [required]

The identifier of the program management account.

Constraints:

  • min: 17
  • max: 1011
  • pattern: (arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[a-zA-Z]+/program-management-account/)?pma-[a-z0-9]{13}

note -> (string)

A note explaining the reason for revoking the service period.

Constraints:

  • min: 1
  • max: 300
  • pattern: [^\x00-\x1F\x7F]*

Shorthand Syntax:

startServicePeriodPayload={programManagementAccountIdentifier=string,note=string,servicePeriodType=string,minimumNoticeDays=string,endDate=timestamp},revokeServicePeriodPayload={programManagementAccountIdentifier=string,note=string}

JSON Syntax:

{
  "startServicePeriodPayload": {
    "programManagementAccountIdentifier": "string",
    "note": "string",
    "servicePeriodType": "MINIMUM_NOTICE_PERIOD"|"FIXED_COMMITMENT_PERIOD",
    "minimumNoticeDays": "string",
    "endDate": timestamp
  },
  "revokeServicePeriodPayload": {
    "programManagementAccountIdentifier": "string",
    "note": "string"
  }
}

--client-token (string)

A unique, case-sensitive identifier to ensure idempotency of the request.

Constraints:

  • min: 1
  • max: 64
  • pattern: [!-~]*

--tags (list)

Key-value pairs to associate with the channel handshake.

(structure)

A key-value pair that can be associated with a resource.

key -> (string) [required]

The key of the tag.

Constraints:

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

value -> (string) [required]

The value of the tag.

Constraints:

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

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "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

channelHandshakeDetail -> (structure)

Details of the created channel handshake.

id -> (string)

The unique identifier of the created handshake.

Constraints:

  • min: 16
  • max: 16
  • pattern: ch-[a-z0-9]{13}

arn -> (string)

The Amazon Resource Name (ARN) of the created handshake.

Constraints:

  • min: 1
  • max: 1011
© Copyright 2025, Amazon Web Services. Created using Sphinx.