1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package organizations
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/organizations/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Sends an invitation to another account to join your organization as a member
// account. Organizations sends email on your behalf to the email address that is
// associated with the other account's owner. The invitation is implemented as a Handshake
// whose details are in the response.
//
// - You can invite Amazon Web Services accounts only from the same seller as
// the management account. For example, if your organization's management account
// was created by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services
// seller in India, you can invite only other AISPL accounts to your organization.
// You can't combine accounts from AISPL and Amazon Web Services or from any other
// Amazon Web Services seller. For more information, see [Consolidated billing in India].
//
// - If you receive an exception that indicates that you exceeded your account
// limits for the organization or that the operation failed because your
// organization is still initializing, wait one hour and then try again. If the
// error persists after an hour, contact [Amazon Web Services Support].
//
// If the request includes tags, then the requester must have the
// organizations:TagResource permission.
//
// This operation can be called only from the organization's management account.
//
// [Amazon Web Services Support]: https://console.aws.amazon.com/support/home#/
// [Consolidated billing in India]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilling-India.html
func (c *Client) InviteAccountToOrganization(ctx context.Context, params *InviteAccountToOrganizationInput, optFns ...func(*Options)) (*InviteAccountToOrganizationOutput, error) {
if params == nil {
params = &InviteAccountToOrganizationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "InviteAccountToOrganization", params, optFns, c.addOperationInviteAccountToOrganizationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*InviteAccountToOrganizationOutput)
out.ResultMetadata = metadata
return out, nil
}
type InviteAccountToOrganizationInput struct {
// The identifier (ID) of the Amazon Web Services account that you want to invite
// to join your organization. This is a JSON object that contains the following
// elements:
//
// { "Type": "ACCOUNT", "Id": "< account id number >" }
//
// If you use the CLI, you can submit this as a single string, similar to the
// following example:
//
// --target Id=123456789012,Type=ACCOUNT
//
// If you specify "Type": "ACCOUNT" , you must provide the Amazon Web Services
// account ID number as the Id . If you specify "Type": "EMAIL" , you must specify
// the email address that is associated with the account.
//
// --target Id=diego@example.com,Type=EMAIL
//
// This member is required.
Target *types.HandshakeParty
// Additional information that you want to include in the generated email to the
// recipient account owner.
Notes *string
// A list of tags that you want to attach to the account when it becomes a member
// of the organization. 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 account. 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 an account, then the entire request fails and invitations are not sent.
//
// [Tagging Organizations resources]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html
Tags []types.Tag
noSmithyDocumentSerde
}
type InviteAccountToOrganizationOutput struct {
// A structure that contains details about the handshake that is created to
// support this invitation request.
Handshake *types.Handshake
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationInviteAccountToOrganizationMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpInviteAccountToOrganization{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpInviteAccountToOrganization{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "InviteAccountToOrganization"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpInviteAccountToOrganizationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opInviteAccountToOrganization(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opInviteAccountToOrganization(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "InviteAccountToOrganization",
}
}
|