partner_accounts

Creates, updates, deletes, gets or lists a partner_accounts resource.

Overview

Name	partner_accounts
Type	Resource
Id	aws.iotwireless.partner_accounts

Fields

The following fields are returned by SELECT queries:

get_partner_account

Name	Datatype	Description
account_linked	boolean	Whether the partner account is linked to the AWS account.
sidewalk	object	Information about a Sidewalk account.

list_partner_accounts

Name	Datatype	Description
next_token	string	The token to use to get the next set of results, or null if there are no additional results.
sidewalk	array	The Sidewalk account credentials.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_partner_account	select	partner_account_id, partnerType, region		Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.
list_partner_accounts	select	region	nextToken, maxResults	Lists the partner accounts associated with your AWS account.
update_partner_account	update	partner_account_id, partnerType, region		Updates properties of a partner account.
associate_aws_account_with_partner_account	update	region		Associates a partner account with your AWS account.
disassociate_aws_account_from_partner_account	exec	partner_account_id, partnerType, region		Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
partnerType	string	The partner type.
partner_account_id	string	The partner account ID to disassociate from the AWS account.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in this operation.
nextToken	string	To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

SELECT examples

get_partner_account

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

SELECT
account_linked,
sidewalk
FROM aws.iotwireless.partner_accounts
WHERE partner_account_id = '{{ partner_account_id }}' -- required
AND partnerType = '{{ partnerType }}' -- required
AND region = '{{ region }}' -- required
;

list_partner_accounts

Lists the partner accounts associated with your AWS account.

SELECT
next_token,
sidewalk
FROM aws.iotwireless.partner_accounts
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

update_partner_account

Updates properties of a partner account.

UPDATE aws.iotwireless.partner_accounts
SET 
Sidewalk = '{{ Sidewalk }}'
WHERE 
partner_account_id = '{{ partner_account_id }}' --required
AND partnerType = '{{ partnerType }}' --required
AND region = '{{ region }}' --required;

associate_aws_account_with_partner_account

Associates a partner account with your AWS account.

UPDATE aws.iotwireless.partner_accounts
SET 
Sidewalk = '{{ Sidewalk }}',
ClientRequestToken = '{{ ClientRequestToken }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
RETURNING
arn,
sidewalk;

Lifecycle Methods

disassociate_aws_account_from_partner_account

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

EXEC aws.iotwireless.partner_accounts.disassociate_aws_account_from_partner_account 
@partner_account_id='{{ partner_account_id }}' --required, 
@partnerType='{{ partnerType }}' --required, 
@region='{{ region }}' --required
;