Organizations / Client / list_inbound_responsibility_transfers

list_inbound_responsibility_transfers¶

Organizations.Client.list_inbound_responsibility_transfers(**kwargs)¶

Lists transfers that allow you to manage the specified responsibilities for another organization. This operation returns both transfer invitations and transfers.

Note

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

Request Syntax

response = client.list_inbound_responsibility_transfers(
    Type='BILLING',
    Id='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

Type (string) –
[REQUIRED]

The type of responsibility. Currently, only BILLING is supported.
Id (string) – ID for the transfer.
NextToken (string) – The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.
MaxResults (integer) – The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

Return type:

dict

Returns:

Response Syntax

{
    'ResponsibilityTransfers': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Id': 'string',
            'Type': 'BILLING',
            'Status': 'REQUESTED'|'DECLINED'|'CANCELED'|'EXPIRED'|'ACCEPTED'|'WITHDRAWN',
            'Source': {
                'ManagementAccountId': 'string',
                'ManagementAccountEmail': 'string'
            },
            'Target': {
                'ManagementAccountId': 'string',
                'ManagementAccountEmail': 'string'
            },
            'StartTimestamp': datetime(2015, 1, 1),
            'EndTimestamp': datetime(2015, 1, 1),
            'ActiveHandshakeId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ResponsibilityTransfers (list) –
  
  A ResponsibilityTransfers object. Contains details for a transfer.
  - (dict) –
    
    Contains details for a transfer. A transfer is the arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.
    - Arn (string) –
      
      Amazon Resource Name (ARN) for the transfer.
    - Name (string) –
      
      Name assigned to the transfer.
    - Id (string) –
      
      ID for the transfer.
    - Type (string) –
      
      The type of transfer. Currently, only BILLING is supported.
    - Status (string) –
      
      Status for the transfer.
    - Source (dict) –
      
      Account that allows another account external to its organization to manage the specified responsibilities for the organization.
      - ManagementAccountId (string) –
        
        ID for the management account.
      - ManagementAccountEmail (string) –
        
        Email address for the management account.
    - Target (dict) –
      
      Account that manages the specified responsibilities for another organization.
      - ManagementAccountId (string) –
        
        ID for the management account.
      - ManagementAccountEmail (string) –
        
        Email address for the management account.
    - StartTimestamp (datetime) –
      
      Timestamp when the transfer starts.
    - EndTimestamp (datetime) –
      
      Timestamp when the transfer ends.
    - ActiveHandshakeId (string) –
      
      ID for the handshake of the transfer.
- NextToken (string) –
  
  If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

Exceptions

Organizations.Client.exceptions.AccessDeniedException
Organizations.Client.exceptions.AWSOrganizationsNotInUseException
Organizations.Client.exceptions.ResponsibilityTransferNotFoundException
Organizations.Client.exceptions.ConstraintViolationException
Organizations.Client.exceptions.InvalidInputException
Organizations.Client.exceptions.ServiceException
Organizations.Client.exceptions.TooManyRequestsException
Organizations.Client.exceptions.UnsupportedAPIEndpointException