[ aws . iotwireless ]

associate-aws-account-with-partner-account

Description

Associates a partner account with your AWS account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  associate-aws-account-with-partner-account
--sidewalk <value>
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--sidewalk (structure)

The Sidewalk account credentials.

AmazonId -> (string)

The Sidewalk Amazon ID.

AppServerPrivateKey -> (string)

The Sidewalk application server private key.

Shorthand Syntax:

AmazonId=string,AppServerPrivateKey=string

JSON Syntax:

{
  "AmazonId": "string",
  "AppServerPrivateKey": "string"
}

--client-request-token (string)

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

--tags (list)

The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

(structure)

A simple label consisting of a customer-defined key-value pair

Key -> (string)

The tag’s key value.

Value -> (string)

The tag’s value.

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.

See ‘aws help’ for descriptions of global parameters.

Examples

To associate a partner account with your AWS account

The following associate-aws-account-with-partner-account example associates the following Sidewalk account credentials with your AWS account.

aws iotwireless associate-aws-account-with-partner-account \
    --sidewalk AmazonId="12345678901234",AppServerPrivateKey="a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234"

Output:

{
    "Sidewalk": {
        "AmazonId": "12345678901234",
        "AppServerPrivateKey": "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234"
    }
}

For more information, see Amazon Sidewalk Integration for AWS IoT Core in the AWS IoT Developers Guide.

Output

Sidewalk -> (structure)

The Sidewalk account credentials.

AmazonId -> (string)

The Sidewalk Amazon ID.

AppServerPrivateKey -> (string)

The Sidewalk application server private key.

Arn -> (string)

The Amazon Resource Name of the resource.