[ aws . iotwireless ]

get-partner-account

Description

Gets information about a partner account. If PartnerAccountId and PartnerType are null , returns all partner accounts.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-partner-account
--partner-account-id <value>
--partner-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--partner-account-id (string)

The partner account ID to disassociate from the AWS account.

--partner-type (string)

The partner type.

Possible values:

• Sidewalk

--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 get the partner account information

The following get-partner-account example gets information about your Sidewalk account that has the following ID.

aws iotwireless get-partner-account \
    --partner-account-id "12345678901234" \
    --partner-type "Sidewalk"

Output:

{
    "Sidewalk": {
        "AmazonId": "12345678901234",
        "Fingerprint": "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234"
    },
    "AccountLinked": false
}

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.

Fingerprint -> (string)

The fingerprint of the Sidewalk application server private key.

Arn -> (string)

The Amazon Resource Name of the resource.

AccountLinked -> (boolean)

Whether the partner account is linked to the AWS account.