responsibility_transfers

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

Overview

Name	responsibility_transfers
Type	Resource
Id	aws.organizations.responsibility_transfers

Fields

The following fields are returned by SELECT queries:

describe_responsibility_transfer

Name	Datatype	Description
active_handshake_id	string	ID for the handshake of the transfer. (pattern: <code>^h-[0-9a-z]{8,32}$</code>)
arn	string	Amazon Resource Name (ARN) for the transfer. (pattern: <code>^arn:[a-z0-9][a-z0-9-.]{0,62}:organizations::\d{12}:transfer/o-[a-z0-9]{10,32}/(billing)/(inbound|outbound)/rt-[0-9a-z]{8,32}$</code>)
end_timestamp	string (date-time)	Timestamp when the transfer ends.
id	string	ID for the transfer. (pattern: <code>^rt-[0-9a-z]{8,32}$</code>)
name	string	Name assigned to the transfer. (pattern: <code>^[ -~]+$</code>)
source	object	Account that allows another account external to its organization to manage the specified responsibilities for the organization.
start_timestamp	string (date-time)	Timestamp when the transfer starts.
status	string	Status for the transfer. (REQUESTED, DECLINED, CANCELED, EXPIRED, ACCEPTED, WITHDRAWN)
target	object	Account that manages the specified responsibilities for another organization.
type	string	The type of transfer. Currently, only BILLING is supported. (BILLING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_responsibility_transfer	select	region		Returns details for a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.
update_responsibility_transfer	update	region, Id, Name		Updates a transfer. A transfer is the arrangement between two management accounts where one account designates the other with specified responsibilities for their organization. You can update the name assigned to a transfer.
terminate_responsibility_transfer	delete	region		Ends a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization. When a transfer ends, Organizations publishes a ResponsibilityTransferTerminated service event to CloudTrail. Each affected account receives this event, including upstream participants such as distributors in a chained transfer. For an example log entry, see Example log entries: TerminateResponsibilityTransfer in the Organizations User Guide.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_responsibility_transfer

Returns details for a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.

SELECT
active_handshake_id,
arn,
end_timestamp,
id,
name,
source,
start_timestamp,
status,
target,
type
FROM aws.organizations.responsibility_transfers
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_responsibility_transfer

Updates a transfer. A transfer is the arrangement between two management accounts where one account designates the other with specified responsibilities for their organization. You can update the name assigned to a transfer.

UPDATE aws.organizations.responsibility_transfers
SET 
Id = '{{ Id }}',
Name = '{{ Name }}'
WHERE 
region = '{{ region }}' --required
AND Id = '{{ Id }}' --required
AND Name = '{{ Name }}' --required
RETURNING
responsibility_transfer;

DELETE examples

terminate_responsibility_transfer

Ends a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization. When a transfer ends, Organizations publishes a ResponsibilityTransferTerminated service event to CloudTrail. Each affected account receives this event, including upstream participants such as distributors in a chained transfer. For an example log entry, see Example log entries: TerminateResponsibilityTransfer in the Organizations User Guide.

DELETE FROM aws.organizations.responsibility_transfers
WHERE region = '{{ region }}' --required
;