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

create-connection-invitation

Description

Creates a new connection invitation to establish a partnership with another organization.

See also: AWS API Documentation

Synopsis

  create-connection-invitation
--catalog <value>
[--client-token <value>]
--connection-type <value>
--email <value>
--message <value>
--name <value>
--receiver-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 where the connection invitation will be created.

--client-token (string)

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

--connection-type (string)

The type of connection being requested (e.g., reseller, distributor, technology partner).

Possible values:

  • OPPORTUNITY_COLLABORATION
  • SUBSIDIARY

--email (string)

The email address of the person to send the connection invitation to.

--message (string)

A custom message to include with the connection invitation.

--name (string)

The name of the person sending the connection invitation.

--receiver-identifier (string)

The identifier of the organization or partner to invite for connection.

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

Catalog -> (string)

The catalog identifier where the connection invitation was created.

Id -> (string)

The unique identifier of the created connection invitation.

Arn -> (string)

The Amazon Resource Name (ARN) of the created connection invitation.

ConnectionId -> (string)

The identifier of the connection associated with this invitation.

ConnectionType -> (string)

The type of connection being requested in the invitation.

CreatedAt -> (timestamp)

The timestamp when the connection invitation was created.

UpdatedAt -> (timestamp)

The timestamp when the connection invitation was last updated.

ExpiresAt -> (timestamp)

The timestamp when the connection invitation will expire if not responded to.

OtherParticipantIdentifier -> (string)

The identifier of the organization or partner being invited.

ParticipantType -> (string)

The type of participant (inviter or invitee) in the connection invitation.

Status -> (string)

The current status of the connection invitation (pending, accepted, rejected, etc.).

InvitationMessage -> (string)

The custom message included with the connection invitation.

InviterEmail -> (string)

The email address of the person who sent the connection invitation.

InviterName -> (string)

The name of the person who sent the connection invitation.