Invite Organization To Transfer Responsibility

organizations_invite_organization_to_transfer_responsibility

R Documentation

Sends an invitation to another organization's management account to designate your account with the specified responsibilities for their organization

Description

Sends an invitation to another organization's management account to designate your account with the specified responsibilities for their organization. The invitation is implemented as a Handshake whose details are in the response.

You can only call this operation from the management account.

Usage

organizations_invite_organization_to_transfer_responsibility(Type,
  Target, Notes, StartTimestamp, SourceName, Tags)

Arguments

Type	[required] The type of responsibility you want to designate to your organization. Currently, only BILLING is supported.
Target	[required] A HandshakeParty object. Contains details for the account you want to invite. Currently, only ACCOUNT and EMAIL are supported.
Notes	Additional information that you want to include in the invitation.
StartTimestamp	[required] Timestamp when the recipient will begin managing the specified responsibilities.
SourceName	[required] Name you want to assign to the transfer.
Tags	A list of tags that you want to attach to the transfer. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide. Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the transfer. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant. If any one of the tags is not valid or if you exceed the allowed number of tags for a transfer, then the entire request fails and invitations are not sent.

Value

A list with the following syntax:

list(
  Handshake = list(
    Id = "string",
    Arn = "string",
    Parties = list(
      list(
        Id = "string",
        Type = "ACCOUNT"|"ORGANIZATION"|"EMAIL"
      )
    ),
    State = "REQUESTED"|"OPEN"|"CANCELED"|"ACCEPTED"|"DECLINED"|"EXPIRED",
    RequestedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    ExpirationTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Action = "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"|"TRANSFER_RESPONSIBILITY",
    Resources = list(
      list(
        Value = "string",
        Type = "ACCOUNT"|"ORGANIZATION"|"ORGANIZATION_FEATURE_SET"|"EMAIL"|"MASTER_EMAIL"|"MASTER_NAME"|"NOTES"|"PARENT_HANDSHAKE"|"RESPONSIBILITY_TRANSFER"|"TRANSFER_START_TIMESTAMP"|"TRANSFER_TYPE"|"MANAGEMENT_ACCOUNT"|"MANAGEMENT_EMAIL"|"MANAGEMENT_NAME",
        Resources = list()
      )
    )
  )
)

Request syntax

svc$invite_organization_to_transfer_responsibility(
  Type = "BILLING",
  Target = list(
    Id = "string",
    Type = "ACCOUNT"|"ORGANIZATION"|"EMAIL"
  ),
  Notes = "string",
  StartTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  SourceName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)