{ "version":"2.0", "metadata":{ "apiVersion":"2018-01-04", "endpointPrefix":"ram", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"RAM", "serviceFullName":"AWS Resource Access Manager", "serviceId":"RAM", "signatureVersion":"v4", "uid":"ram-2018-01-04" }, "operations":{ "AcceptResourceShareInvitation":{ "name":"AcceptResourceShareInvitation", "http":{ "method":"POST", "requestUri":"/acceptresourceshareinvitation" }, "input":{"shape":"AcceptResourceShareInvitationRequest"}, "output":{"shape":"AcceptResourceShareInvitationResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ResourceShareInvitationArnNotFoundException"}, {"shape":"ResourceShareInvitationAlreadyAcceptedException"}, {"shape":"ResourceShareInvitationAlreadyRejectedException"}, {"shape":"ResourceShareInvitationExpiredException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidClientTokenException"}, {"shape":"IdempotentParameterMismatchException"} ], "documentation":"

Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.

" }, "AssociateResourceShare":{ "name":"AssociateResourceShare", "http":{ "method":"POST", "requestUri":"/associateresourceshare" }, "input":{"shape":"AssociateResourceShareRequest"}, "output":{"shape":"AssociateResourceShareResponse"}, "errors":[ {"shape":"IdempotentParameterMismatchException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidStateTransitionException"}, {"shape":"ResourceShareLimitExceededException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidStateTransitionException"}, {"shape":"InvalidClientTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"UnknownResourceException"}, {"shape":"ThrottlingException"} ], "documentation":"

Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.

" }, "AssociateResourceSharePermission":{ "name":"AssociateResourceSharePermission", "http":{ "method":"POST", "requestUri":"/associateresourcesharepermission" }, "input":{"shape":"AssociateResourceSharePermissionRequest"}, "output":{"shape":"AssociateResourceSharePermissionResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidClientTokenException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.

" }, "CreatePermission":{ "name":"CreatePermission", "http":{ "method":"POST", "requestUri":"/createpermission" }, "input":{"shape":"CreatePermissionRequest"}, "output":{"shape":"CreatePermissionResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidPolicyException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"PermissionAlreadyExistsException"}, {"shape":"MalformedPolicyTemplateException"}, {"shape":"InvalidClientTokenException"}, {"shape":"PermissionLimitExceededException"}, {"shape":"IdempotentParameterMismatchException"} ], "documentation":"

Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.

" }, "CreatePermissionVersion":{ "name":"CreatePermissionVersion", "http":{ "method":"POST", "requestUri":"/createpermissionversion" }, "input":{"shape":"CreatePermissionVersionRequest"}, "output":{"shape":"CreatePermissionVersionResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidPolicyException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"UnknownResourceException"}, {"shape":"MalformedPolicyTemplateException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidClientTokenException"}, {"shape":"IdempotentParameterMismatchException"}, {"shape":"PermissionVersionsLimitExceededException"} ], "documentation":"

Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them.

If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one.

" }, "CreateResourceShare":{ "name":"CreateResourceShare", "http":{ "method":"POST", "requestUri":"/createresourceshare" }, "input":{"shape":"CreateResourceShareRequest"}, "output":{"shape":"CreateResourceShareResponse"}, "errors":[ {"shape":"IdempotentParameterMismatchException"}, {"shape":"InvalidStateTransitionException"}, {"shape":"UnknownResourceException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidClientTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ResourceShareLimitExceededException"}, {"shape":"TagPolicyViolationException"}, {"shape":"TagLimitExceededException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

" }, "DeletePermission":{ "name":"DeletePermission", "http":{ "method":"DELETE", "requestUri":"/deletepermission" }, "input":{"shape":"DeletePermissionRequest"}, "output":{"shape":"DeletePermissionResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidClientTokenException"}, {"shape":"IdempotentParameterMismatchException"} ], "documentation":"

Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.

" }, "DeletePermissionVersion":{ "name":"DeletePermissionVersion", "http":{ "method":"DELETE", "requestUri":"/deletepermissionversion" }, "input":{"shape":"DeletePermissionVersionRequest"}, "output":{"shape":"DeletePermissionVersionResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidClientTokenException"}, {"shape":"IdempotentParameterMismatchException"} ], "documentation":"

Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.

If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.

" }, "DeleteResourceShare":{ "name":"DeleteResourceShare", "http":{ "method":"DELETE", "requestUri":"/deleteresourceshare" }, "input":{"shape":"DeleteResourceShareRequest"}, "output":{"shape":"DeleteResourceShareResponse"}, "errors":[ {"shape":"OperationNotPermittedException"}, {"shape":"IdempotentParameterMismatchException"}, {"shape":"InvalidStateTransitionException"}, {"shape":"UnknownResourceException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidClientTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified resource share.

This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources through this resource share.

" }, "DisassociateResourceShare":{ "name":"DisassociateResourceShare", "http":{ "method":"POST", "requestUri":"/disassociateresourceshare" }, "input":{"shape":"DisassociateResourceShareRequest"}, "output":{"shape":"DisassociateResourceShareResponse"}, "errors":[ {"shape":"IdempotentParameterMismatchException"}, {"shape":"ResourceShareLimitExceededException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidStateTransitionException"}, {"shape":"InvalidClientTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"UnknownResourceException"} ], "documentation":"

Removes the specified principals or resources from participating in the specified resource share.

" }, "DisassociateResourceSharePermission":{ "name":"DisassociateResourceSharePermission", "http":{ "method":"POST", "requestUri":"/disassociateresourcesharepermission" }, "input":{"shape":"DisassociateResourceSharePermissionRequest"}, "output":{"shape":"DisassociateResourceSharePermissionResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidClientTokenException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidStateTransitionException"} ], "documentation":"

Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.

" }, "EnableSharingWithAwsOrganization":{ "name":"EnableSharingWithAwsOrganization", "http":{ "method":"POST", "requestUri":"/enablesharingwithawsorganization" }, "input":{"shape":"EnableSharingWithAwsOrganizationRequest"}, "output":{"shape":"EnableSharingWithAwsOrganizationResponse"}, "errors":[ {"shape":"OperationNotPermittedException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called `AWSServiceRoleForResourceAccessManager` that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM roles and users.

You must call this operation from an IAM role or user in the organization's management account.

" }, "GetPermission":{ "name":"GetPermission", "http":{ "method":"POST", "requestUri":"/getpermission" }, "input":{"shape":"GetPermissionRequest"}, "output":{"shape":"GetPermissionResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MalformedArnException"}, {"shape":"UnknownResourceException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Retrieves the contents of a managed permission in JSON format.

" }, "GetResourcePolicies":{ "name":"GetResourcePolicies", "http":{ "method":"POST", "requestUri":"/getresourcepolicies" }, "input":{"shape":"GetResourcePoliciesRequest"}, "output":{"shape":"GetResourcePoliciesResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceArnNotFoundException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Retrieves the resource policies for the specified resources that you own and have shared.

" }, "GetResourceShareAssociations":{ "name":"GetResourceShareAssociations", "http":{ "method":"POST", "requestUri":"/getresourceshareassociations" }, "input":{"shape":"GetResourceShareAssociationsRequest"}, "output":{"shape":"GetResourceShareAssociationsResponse"}, "errors":[ {"shape":"UnknownResourceException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Retrieves the lists of resources and principals that associated for resource shares that you own.

" }, "GetResourceShareInvitations":{ "name":"GetResourceShareInvitations", "http":{ "method":"POST", "requestUri":"/getresourceshareinvitations" }, "input":{"shape":"GetResourceShareInvitationsRequest"}, "output":{"shape":"GetResourceShareInvitationsResponse"}, "errors":[ {"shape":"ResourceShareInvitationArnNotFoundException"}, {"shape":"InvalidMaxResultsException"}, {"shape":"MalformedArnException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Retrieves details about invitations that you have received for resource shares.

" }, "GetResourceShares":{ "name":"GetResourceShares", "http":{ "method":"POST", "requestUri":"/getresourceshares" }, "input":{"shape":"GetResourceSharesRequest"}, "output":{"shape":"GetResourceSharesResponse"}, "errors":[ {"shape":"UnknownResourceException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Retrieves details about the resource shares that you own or that are shared with you.

" }, "ListPendingInvitationResources":{ "name":"ListPendingInvitationResources", "http":{ "method":"POST", "requestUri":"/listpendinginvitationresources" }, "input":{"shape":"ListPendingInvitationResourcesRequest"}, "output":{"shape":"ListPendingInvitationResourcesResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ResourceShareInvitationArnNotFoundException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"ResourceShareInvitationAlreadyRejectedException"}, {"shape":"ResourceShareInvitationExpiredException"} ], "documentation":"

Lists the resources in a resource share that is shared with you but for which the invitation is still `PENDING`. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.

" }, "ListPermissionAssociations":{ "name":"ListPermissionAssociations", "http":{ "method":"POST", "requestUri":"/listpermissionassociations" }, "input":{"shape":"ListPermissionAssociationsRequest"}, "output":{"shape":"ListPermissionAssociationsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission.

" }, "ListPermissionVersions":{ "name":"ListPermissionVersions", "http":{ "method":"POST", "requestUri":"/listpermissionversions" }, "input":{"shape":"ListPermissionVersionsRequest"}, "output":{"shape":"ListPermissionVersionsResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Lists the available versions of the specified RAM permission.

" }, "ListPermissions":{ "name":"ListPermissions", "http":{ "method":"POST", "requestUri":"/listpermissions" }, "input":{"shape":"ListPermissionsRequest"}, "output":{"shape":"ListPermissionsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Retrieves a list of available RAM permissions that you can use for the supported resource types.

" }, "ListPrincipals":{ "name":"ListPrincipals", "http":{ "method":"POST", "requestUri":"/listprincipals" }, "input":{"shape":"ListPrincipalsRequest"}, "output":{"shape":"ListPrincipalsResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the principals that you are sharing resources with or that are sharing resources with you.

" }, "ListReplacePermissionAssociationsWork":{ "name":"ListReplacePermissionAssociationsWork", "http":{ "method":"POST", "requestUri":"/listreplacepermissionassociationswork" }, "input":{"shape":"ListReplacePermissionAssociationsWorkRequest"}, "output":{"shape":"ListReplacePermissionAssociationsWorkResponse"}, "errors":[ {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.

" }, "ListResourceSharePermissions":{ "name":"ListResourceSharePermissions", "http":{ "method":"POST", "requestUri":"/listresourcesharepermissions" }, "input":{"shape":"ListResourceSharePermissionsRequest"}, "output":{"shape":"ListResourceSharePermissionsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MalformedArnException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Lists the RAM permissions that are associated with a resource share.

" }, "ListResourceTypes":{ "name":"ListResourceTypes", "http":{ "method":"POST", "requestUri":"/listresourcetypes" }, "input":{"shape":"ListResourceTypesRequest"}, "output":{"shape":"ListResourceTypesResponse"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the resource types that can be shared by RAM.

" }, "ListResources":{ "name":"ListResources", "http":{ "method":"POST", "requestUri":"/listresources" }, "input":{"shape":"ListResourcesRequest"}, "output":{"shape":"ListResourcesResponse"}, "errors":[ {"shape":"InvalidResourceTypeException"}, {"shape":"UnknownResourceException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the resources that you added to a resource share or the resources that are shared with you.

" }, "PromotePermissionCreatedFromPolicy":{ "name":"PromotePermissionCreatedFromPolicy", "http":{ "method":"POST", "requestUri":"/promotepermissioncreatedfrompolicy" }, "input":{"shape":"PromotePermissionCreatedFromPolicyRequest"}, "output":{"shape":"PromotePermissionCreatedFromPolicyResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"UnknownResourceException"} ], "documentation":"

When you attach a resource-based policy to a resource, RAM automatically creates a resource share of `featureSet`=`CREATED_FROM_POLICY` with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.

This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions as the original resource-based policy. You can associate this customer managed permission to any resource shares.

Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an appropriate customer managed permission that can be associated with the promoted resource share.

- The original `CREATED_FROM_POLICY` policy isn't deleted, and resource shares using that original policy aren't automatically updated.

- You can't modify a `CREATED_FROM_POLICY` resource share so you can't associate the new customer managed permission by using `ReplacePermsissionAssociations`. However, if you use PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully manageable customer managed permission to the newly promoted `STANDARD` resource share.

- After you promote a resource share, if the original `CREATED_FROM_POLICY` managed permission has no other associations to A resource share, then RAM automatically deletes it.

" }, "PromoteResourceShareCreatedFromPolicy":{ "name":"PromoteResourceShareCreatedFromPolicy", "http":{ "method":"POST", "requestUri":"/promoteresourcesharecreatedfrompolicy" }, "input":{"shape":"PromoteResourceShareCreatedFromPolicyRequest"}, "output":{"shape":"PromoteResourceShareCreatedFromPolicyResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"ResourceShareLimitExceededException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidStateTransitionException"}, {"shape":"UnmatchedPolicyPermissionException"} ], "documentation":"

When you attach a resource-based policy to a resource, RAM automatically creates a resource share of `featureSet`=`CREATED_FROM_POLICY` with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.

This operation promotes the resource share to a `STANDARD` resource share that is fully manageable in RAM. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.

Before you perform this operation, you should first run PromotePermissionCreatedFromPolicyto ensure that you have an appropriate customer managed permission that can be associated with this resource share after its is promoted. If this operation can't find a managed permission that exactly matches the existing `CREATED_FROM_POLICY` permission, then this operation fails.

" }, "RejectResourceShareInvitation":{ "name":"RejectResourceShareInvitation", "http":{ "method":"POST", "requestUri":"/rejectresourceshareinvitation" }, "input":{"shape":"RejectResourceShareInvitationRequest"}, "output":{"shape":"RejectResourceShareInvitationResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ResourceShareInvitationArnNotFoundException"}, {"shape":"ResourceShareInvitationAlreadyAcceptedException"}, {"shape":"ResourceShareInvitationAlreadyRejectedException"}, {"shape":"ResourceShareInvitationExpiredException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InvalidClientTokenException"}, {"shape":"IdempotentParameterMismatchException"} ], "documentation":"

Rejects an invitation to a resource share from another Amazon Web Services account.

" }, "ReplacePermissionAssociations":{ "name":"ReplacePermissionAssociations", "http":{ "method":"POST", "requestUri":"/replacepermissionassociations" }, "input":{"shape":"ReplacePermissionAssociationsRequest"}, "output":{"shape":"ReplacePermissionAssociationsResponse"}, "errors":[ {"shape":"MalformedArnException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"OperationNotPermittedException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidClientTokenException"}, {"shape":"IdempotentParameterMismatchException"} ], "documentation":"

Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.

You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the `fromPermissionArn` and `toPermissionArn` parameters.

You can use the optional `fromPermissionVersion` parameter to update only those resources that use a specified version of the managed permission to the new managed permission.

To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.

" }, "SetDefaultPermissionVersion":{ "name":"SetDefaultPermissionVersion", "http":{ "method":"POST", "requestUri":"/setdefaultpermissionversion" }, "input":{"shape":"SetDefaultPermissionVersionRequest"}, "output":{"shape":"SetDefaultPermissionVersionResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MalformedArnException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"}, {"shape":"UnknownResourceException"}, {"shape":"InvalidClientTokenException"}, {"shape":"IdempotentParameterMismatchException"} ], "documentation":"

Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tagresource" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MalformedArnException"}, {"shape":"UnknownResourceException"}, {"shape":"TagLimitExceededException"}, {"shape":"ResourceArnNotFoundException"}, {"shape":"TagPolicyViolationException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share.

The tags on a managed permission are the same for all versions of the managed permission.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/untagresource" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"UnknownResourceException"}, {"shape":"InvalidParameterException"}, {"shape":"MalformedArnException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Removes the specified tag key and value pairs from the specified resource share or managed permission.

" }, "UpdateResourceShare":{ "name":"UpdateResourceShare", "http":{ "method":"POST", "requestUri":"/updateresourceshare" }, "input":{"shape":"UpdateResourceShareRequest"}, "output":{"shape":"UpdateResourceShareResponse"}, "errors":[ {"shape":"IdempotentParameterMismatchException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"UnknownResourceException"}, {"shape":"MalformedArnException"}, {"shape":"InvalidClientTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Modifies some of the properties of the specified resource share.

" } }, "shapes":{ "AcceptResourceShareInvitationRequest":{ "type":"structure", "required":["resourceShareInvitationArn"], "members":{ "resourceShareInvitationArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the invitation that you want to accept.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" } } }, "AcceptResourceShareInvitationResponse":{ "type":"structure", "members":{ "resourceShareInvitation":{ "shape":"ResourceShareInvitation", "documentation":"

An object that contains information about the specified invitation.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "AssociateResourceSharePermissionRequest":{ "type":"structure", "required":[ "resourceShareArn", "permissionArn" ], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace permissions.

" }, "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

" }, "replace":{ "shape":"Boolean", "documentation":"

Specifies whether the specified permission should replace the existing permission associated with the resource share. Use `true` to replace the current permissions. Use `false` to add the permission to a resource share that currently doesn't have a permission. The default value is `false`.

A resource share can have only one permission per resource type. If a resource share already has a permission for the specified resource type and you don't set `replace` to `true` then the operation returns an error. This helps prevent accidental overwriting of a permission.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" }, "permissionVersion":{ "shape":"Integer", "documentation":"

Specifies the version of the RAM permission to associate with the resource share. You can specify only the version that is currently set as the default version for the permission. If you also set the `replace` pararameter to `true`, then this operation updates an outdated version of the permission to the current default version.

You don't need to specify this parameter because the default behavior is to use the version that is currently set as the default version for the permission. This parameter is supported for backwards compatibility.

" } } }, "AssociateResourceSharePermissionResponse":{ "type":"structure", "members":{ "returnValue":{ "shape":"Boolean", "documentation":"

A return value of `true` indicates that the request succeeded. A value of `false` indicates that the request failed.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "AssociateResourceShareRequest":{ "type":"structure", "required":["resourceShareArn"], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

" }, "resourceArns":{ "shape":"ResourceArnList", "documentation":"

Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be `null` if you want to add only principals.

" }, "principals":{ "shape":"PrincipalArnOrIdList", "documentation":"

Specifies a list of principals to whom you want to the resource share. This can be `null` if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

You can include the following values:

- An Amazon Web Services account ID, for example: `123456789012`

- An Amazon Resource Name (ARN) of an organization in Organizations, for example: `organizations::123456789012:organization/o-exampleorgid`

- An ARN of an organizational unit (OU) in Organizations, for example: `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`

- An ARN of an IAM role, for example: `iam::123456789012:role/rolename`

- An ARN of an IAM user, for example: `iam::123456789012user/username`

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" }, "sources":{ "shape":"SourceArnOrAccountList", "documentation":"

Specifies from which source accounts the service principal has access to the resources in this resource share.

" } } }, "AssociateResourceShareResponse":{ "type":"structure", "members":{ "resourceShareAssociations":{ "shape":"ResourceShareAssociationList", "documentation":"

An array of objects that contain information about the associations.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "AssociatedPermission":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the associated managed permission.

" }, "permissionVersion":{ "shape":"String", "documentation":"

The version of the permission currently associated with the resource share.

" }, "defaultVersion":{ "shape":"Boolean", "documentation":"

Indicates whether the associated resource share is using the default version of the permission.

" }, "resourceType":{ "shape":"String", "documentation":"

The resource type to which this permission applies.

" }, "status":{ "shape":"String", "documentation":"

The current status of the association between the permission and the resource share. The following are the possible values:

- `ATTACHABLE` – This permission or version can be associated with resource shares.

- `UNATTACHABLE` – This permission or version can't currently be associated with resource shares.

- `DELETING` – This permission or version is in the process of being deleted.

- `DELETED` – This permission or version is deleted.

" }, "featureSet":{ "shape":"PermissionFeatureSet", "documentation":"

Indicates what features are available for this resource share. This parameter can have one of the following values:

- STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

- CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

- PROMOTING_TO_STANDARD – This resource share was originally `CREATED_FROM_POLICY`, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to `STANDARD` when complete.

" }, "lastUpdatedTime":{ "shape":"DateTime", "documentation":"

The date and time when the association between the permission and the resource share was last updated.

" }, "resourceShareArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of a resource share associated with this permission.

" } }, "documentation":"

An object that describes a managed permission associated with a resource share.

" }, "AssociatedPermissionList":{ "type":"list", "member":{"shape":"AssociatedPermission"} }, "Boolean":{"type":"boolean"}, "CreatePermissionRequest":{ "type":"structure", "required":[ "name", "resourceType", "policyTemplate" ], "members":{ "name":{ "shape":"PermissionName", "documentation":"

Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services Region.

" }, "resourceType":{ "shape":"String", "documentation":"

Specifies the name of the resource type that this customer managed permission applies to.

The format is `<service-code>:<resource-type>` and is not case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string `ec2:subnet`. To see the list of valid values for this parameter, query the ListResourceTypes operation.

" }, "policyTemplate":{ "shape":"Policy", "documentation":"

A string in JSON format string that contains the following elements of a resource-based policy:

- Effect: must be set to `ALLOW`.

- Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.

- Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.

This template can't include either the `Resource` or `Principal` elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The `Resource` comes from the ARN of the specific resource that you are sharing. The `Principal` comes from the list of identities added to the resource share.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" }, "tags":{ "shape":"TagList", "documentation":"

Specifies a list of one or more tag key and value pairs to attach to the permission.

" } } }, "CreatePermissionResponse":{ "type":"structure", "members":{ "permission":{ "shape":"ResourceSharePermissionSummary", "documentation":"

A structure with information about this customer managed permission.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "CreatePermissionVersionRequest":{ "type":"structure", "required":[ "permissionArn", "policyTemplate" ], "members":{ "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the customer managed permission you're creating a new version for.

" }, "policyTemplate":{ "shape":"Policy", "documentation":"

A string in JSON format string that contains the following elements of a resource-based policy:

- Effect: must be set to `ALLOW`.

- Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.

- Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.

This template can't include either the `Resource` or `Principal` elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The `Resource` comes from the ARN of the specific resource that you are sharing. The `Principal` comes from the list of identities added to the resource share.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" } } }, "CreatePermissionVersionResponse":{ "type":"structure", "members":{ "permission":{"shape":"ResourceSharePermissionDetail"}, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "CreateResourceShareRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"String", "documentation":"

Specifies the name of the resource share.

" }, "resourceArns":{ "shape":"ResourceArnList", "documentation":"

Specifies a list of one or more ARNs of the resources to associate with the resource share.

" }, "principals":{ "shape":"PrincipalArnOrIdList", "documentation":"

Specifies a list of one or more principals to associate with the resource share.

You can include the following values:

- An Amazon Web Services account ID, for example: `123456789012`

- An Amazon Resource Name (ARN) of an organization in Organizations, for example: `organizations::123456789012:organization/o-exampleorgid`

- An ARN of an organizational unit (OU) in Organizations, for example: `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`

- An ARN of an IAM role, for example: `iam::123456789012:role/rolename`

- An ARN of an IAM user, for example: `iam::123456789012user/username`

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

" }, "tags":{ "shape":"TagList", "documentation":"

Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.

" }, "allowExternalPrincipals":{ "shape":"Boolean", "documentation":"

Specifies whether principals outside your organization in Organizations can be associated with a resource share. A value of `true` lets you share with individual Amazon Web Services accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an Amazon Web Services Organization. The default value is `true`.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" }, "permissionArns":{ "shape":"PermissionArnList", "documentation":"

Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

" }, "sources":{ "shape":"SourceArnOrAccountList", "documentation":"

Specifies from which source accounts the service principal has access to the resources in this resource share.

" } } }, "CreateResourceShareResponse":{ "type":"structure", "members":{ "resourceShare":{ "shape":"ResourceShare", "documentation":"

An object with information about the new resource share.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "DateTime":{"type":"timestamp"}, "DeletePermissionRequest":{ "type":"structure", "required":["permissionArn"], "members":{ "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the customer managed permission that you want to delete.

", "location":"querystring", "locationName":"permissionArn" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

", "location":"querystring", "locationName":"clientToken" } } }, "DeletePermissionResponse":{ "type":"structure", "members":{ "returnValue":{ "shape":"Boolean", "documentation":"

A boolean that indicates whether the delete operations succeeded.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" }, "permissionStatus":{ "shape":"PermissionStatus", "documentation":"

This operation is performed asynchronously, and this response parameter indicates the current status.

" } } }, "DeletePermissionVersionRequest":{ "type":"structure", "required":[ "permissionArn", "permissionVersion" ], "members":{ "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the permission with the version you want to delete.

", "location":"querystring", "locationName":"permissionArn" }, "permissionVersion":{ "shape":"Integer", "documentation":"

Specifies the version number to delete.

You can't delete the default version for a customer managed permission.

You can't delete a version if it's the only version of the permission. You must either first create another version, or delete the permission completely.

You can't delete a version if it is attached to any resource shares. If the version is the default, you must first use SetDefaultPermissionVersion to set a different version as the default for the customer managed permission, and then use AssociateResourceSharePermission to update your resource shares to use the new default version.

", "location":"querystring", "locationName":"permissionVersion" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

", "location":"querystring", "locationName":"clientToken" } } }, "DeletePermissionVersionResponse":{ "type":"structure", "members":{ "returnValue":{ "shape":"Boolean", "documentation":"

A boolean value that indicates whether the operation is successful.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" }, "permissionStatus":{ "shape":"PermissionStatus", "documentation":"

This operation is performed asynchronously, and this response parameter indicates the current status.

" } } }, "DeleteResourceShareRequest":{ "type":"structure", "required":["resourceShareArn"], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the resource share to delete.

", "location":"querystring", "locationName":"resourceShareArn" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

", "location":"querystring", "locationName":"clientToken" } } }, "DeleteResourceShareResponse":{ "type":"structure", "members":{ "returnValue":{ "shape":"Boolean", "documentation":"

A return value of `true` indicates that the request succeeded. A value of `false` indicates that the request failed.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "DisassociateResourceSharePermissionRequest":{ "type":"structure", "required":[ "resourceShareArn", "permissionArn" ], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource share that you want to remove the managed permission from.

" }, "permissionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the managed permission to disassociate from the resource share. Changes to permissions take effect immediately.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" } } }, "DisassociateResourceSharePermissionResponse":{ "type":"structure", "members":{ "returnValue":{ "shape":"Boolean", "documentation":"

A return value of `true` indicates that the request succeeded. A value of `false` indicates that the request failed.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "DisassociateResourceShareRequest":{ "type":"structure", "required":["resourceShareArn"], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies Amazon Resource Name (ARN) of the resource share that you want to remove resources or principals from.

" }, "resourceArns":{ "shape":"ResourceArnList", "documentation":"

Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals associated with the resource share.

" }, "principals":{ "shape":"PrincipalArnOrIdList", "documentation":"

Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

You can include the following values:

- An Amazon Web Services account ID, for example: `123456789012`

- An Amazon Resource Name (ARN) of an organization in Organizations, for example: `organizations::123456789012:organization/o-exampleorgid`

- An ARN of an organizational unit (OU) in Organizations, for example: `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`

- An ARN of an IAM role, for example: `iam::123456789012:role/rolename`

- An ARN of an IAM user, for example: `iam::123456789012user/username`

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" }, "sources":{ "shape":"SourceArnOrAccountList", "documentation":"

Specifies from which source accounts the service principal no longer has access to the resources in this resource share.

" } } }, "DisassociateResourceShareResponse":{ "type":"structure", "members":{ "resourceShareAssociations":{ "shape":"ResourceShareAssociationList", "documentation":"

An array of objects with information about the updated associations for this resource share.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "EnableSharingWithAwsOrganizationRequest":{ "type":"structure", "members":{ } }, "EnableSharingWithAwsOrganizationResponse":{ "type":"structure", "members":{ "returnValue":{ "shape":"Boolean", "documentation":"

A return value of `true` indicates that the request succeeded. A value of `false` indicates that the request failed.

" } } }, "GetPermissionRequest":{ "type":"structure", "required":["permissionArn"], "members":{ "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the permission whose contents you want to retrieve. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

" }, "permissionVersion":{ "shape":"Integer", "documentation":"

Specifies the version number of the RAM permission to retrieve. If you don't specify this parameter, the operation retrieves the default version.

To see the list of available versions, use ListPermissionVersions.

" } } }, "GetPermissionResponse":{ "type":"structure", "members":{ "permission":{ "shape":"ResourceSharePermissionDetail", "documentation":"

An object with details about the permission.

" } } }, "GetResourcePoliciesRequest":{ "type":"structure", "required":["resourceArns"], "members":{ "resourceArns":{ "shape":"ResourceArnList", "documentation":"

Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

" }, "principal":{ "shape":"String", "documentation":"

Specifies the principal.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" } } }, "GetResourcePoliciesResponse":{ "type":"structure", "members":{ "policies":{ "shape":"PolicyList", "documentation":"

An array of resource policy documents in JSON format.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "GetResourceShareAssociationsRequest":{ "type":"structure", "required":["associationType"], "members":{ "associationType":{ "shape":"ResourceShareAssociationType", "documentation":"

Specifies whether you want to retrieve the associations that involve a specified resource or principal.

- `PRINCIPAL` – list the principals whose associations you want to see.

- `RESOURCE` – list the resources whose associations you want to see.

" }, "resourceShareArns":{ "shape":"ResourceShareArnList", "documentation":"

Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.

" }, "resourceArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.

You cannot specify this parameter if the association type is `PRINCIPAL`.

" }, "principal":{ "shape":"String", "documentation":"

Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resource Name (ARN) of an individual IAM role or user.

You cannot specify this parameter if the association type is `RESOURCE`.

" }, "associationStatus":{ "shape":"ResourceShareAssociationStatus", "documentation":"

Specifies that you want to retrieve only associations that have this status.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" } } }, "GetResourceShareAssociationsResponse":{ "type":"structure", "members":{ "resourceShareAssociations":{ "shape":"ResourceShareAssociationList", "documentation":"

An array of objects that contain the details about the associations.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "GetResourceShareInvitationsRequest":{ "type":"structure", "members":{ "resourceShareInvitationArns":{ "shape":"ResourceShareInvitationArnList", "documentation":"

Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

" }, "resourceShareArns":{ "shape":"ResourceShareArnList", "documentation":"

Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" } } }, "GetResourceShareInvitationsResponse":{ "type":"structure", "members":{ "resourceShareInvitations":{ "shape":"ResourceShareInvitationList", "documentation":"

An array of objects that contain the details about the invitations.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "GetResourceSharesRequest":{ "type":"structure", "required":["resourceOwner"], "members":{ "resourceShareArns":{ "shape":"ResourceShareArnList", "documentation":"

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

" }, "resourceShareStatus":{ "shape":"ResourceShareStatus", "documentation":"

Specifies that you want to retrieve details of only those resource shares that have this status.

" }, "resourceOwner":{ "shape":"ResourceOwner", "documentation":"

Specifies that you want to retrieve details of only those resource shares that match the following:

- `SELF` – resource shares that your account shares with other accounts

- `OTHER-ACCOUNTS` – resource shares that other accounts share with your account

" }, "name":{ "shape":"String", "documentation":"

Specifies the name of an individual resource share that you want to retrieve details about.

" }, "tagFilters":{ "shape":"TagFilters", "documentation":"

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" }, "permissionArn":{ "shape":"String", "documentation":"

Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

" }, "permissionVersion":{ "shape":"Integer", "documentation":"

Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

" } } }, "GetResourceSharesResponse":{ "type":"structure", "members":{ "resourceShares":{ "shape":"ResourceShareList", "documentation":"

An array of objects that contain the information about the resource shares.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "IdempotentParameterMismatchException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

", "error":{"httpStatusCode":400}, "exception":true }, "Integer":{"type":"integer"}, "InvalidClientTokenException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified client token isn't valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidMaxResultsException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified value for `MaxResults` isn't valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidNextTokenException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified value for `NextToken` isn't valid. You must specify a value you received in the `NextToken` response of a previous call to this operation.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidParameterException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because a parameter you specified isn't valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidPolicyException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because a policy you specified isn't valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResourceTypeException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified resource type isn't valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidStateTransitionException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the requested operation isn't valid for the resource share in its current state.

", "error":{"httpStatusCode":400}, "exception":true }, "ListPendingInvitationResourcesRequest":{ "type":"structure", "required":["resourceShareInvitationArn"], "members":{ "resourceShareInvitationArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" }, "resourceRegionScope":{ "shape":"ResourceRegionScopeFilter", "documentation":"

Specifies that you want the results to include only resources that have the specified scope.

- `ALL` – the results include both global and regional resources or resource types.

- `GLOBAL` – the results include only global resources or resource types.

- `REGIONAL` – the results include only regional resources or resource types.

The default value is `ALL`.

" } } }, "ListPendingInvitationResourcesResponse":{ "type":"structure", "members":{ "resources":{ "shape":"ResourceList", "documentation":"

An array of objects that contain the information about the resources included the specified resource share.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "ListPermissionAssociationsRequest":{ "type":"structure", "members":{ "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the managed permission.

" }, "permissionVersion":{ "shape":"Integer", "documentation":"

Specifies that you want to list only those associations with resource shares that use this version of the managed permission. If you don't provide a value for this parameter, then the operation returns information about associations with resource shares that use any version of the managed permission.

" }, "associationStatus":{ "shape":"ResourceShareAssociationStatus", "documentation":"

Specifies that you want to list only those associations with resource shares that match this status.

" }, "resourceType":{ "shape":"String", "documentation":"

Specifies that you want to list only those associations with resource shares that include at least one resource of this resource type.

" }, "featureSet":{ "shape":"PermissionFeatureSet", "documentation":"

Specifies that you want to list only those associations with resource shares that have a `featureSet` with this value.

" }, "defaultVersion":{ "shape":"Boolean", "documentation":"

When `true`, specifies that you want to list only those associations with resource shares that use the default version of the specified managed permission.

When `false` (the default value), lists associations with resource shares that use any version of the specified managed permission.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" } } }, "ListPermissionAssociationsResponse":{ "type":"structure", "members":{ "permissions":{ "shape":"AssociatedPermissionList", "documentation":"

A structure with information about this customer managed permission.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "ListPermissionVersionsRequest":{ "type":"structure", "required":["permissionArn"], "members":{ "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the RAM permission whose versions you want to list. You can use the `permissionVersion` parameter on the AssociateResourceSharePermission operation to specify a non-default version to attach.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" } } }, "ListPermissionVersionsResponse":{ "type":"structure", "members":{ "permissions":{ "shape":"ResourceSharePermissionList", "documentation":"

An array of objects that contain details for each of the available versions.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "ListPermissionsRequest":{ "type":"structure", "members":{ "resourceType":{ "shape":"String", "documentation":"

Specifies that you want to list only those permissions that apply to the specified resource type. This parameter is not case sensitive.

For example, to list only permissions that apply to Amazon EC2 subnets, specify `ec2:subnet`. You can use the ListResourceTypes operation to get the specific string required.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" }, "permissionType":{ "shape":"PermissionTypeFilter", "documentation":"

Specifies that you want to list only permissions of this type:

- `AWS` – returns only Amazon Web Services managed permissions.

- `LOCAL` – returns only customer managed permissions

- `ALL` – returns both Amazon Web Services managed permissions and customer managed permissions.

If you don't specify this parameter, the default is `All`.

" } } }, "ListPermissionsResponse":{ "type":"structure", "members":{ "permissions":{ "shape":"ResourceSharePermissionList", "documentation":"

An array of objects with information about the permissions.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "ListPrincipalsRequest":{ "type":"structure", "required":["resourceOwner"], "members":{ "resourceOwner":{ "shape":"ResourceOwner", "documentation":"

Specifies that you want to list information for only resource shares that match the following:

- `SELF` – principals that your account is sharing resources with

- `OTHER-ACCOUNTS` – principals that are sharing resources with your account

" }, "resourceArn":{ "shape":"String", "documentation":"

Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

" }, "principals":{ "shape":"PrincipalArnOrIdList", "documentation":"

Specifies that you want to list information for only the listed principals.

You can include the following values:

- An Amazon Web Services account ID, for example: `123456789012`

- An Amazon Resource Name (ARN) of an organization in Organizations, for example: `organizations::123456789012:organization/o-exampleorgid`

- An ARN of an organizational unit (OU) in Organizations, for example: `organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`

- An ARN of an IAM role, for example: `iam::123456789012:role/rolename`

- An ARN of an IAM user, for example: `iam::123456789012user/username`

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

" }, "resourceType":{ "shape":"String", "documentation":"

Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

For a list of valid values, query the ListResourceTypes operation.

" }, "resourceShareArns":{ "shape":"ResourceShareArnList", "documentation":"

Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" } } }, "ListPrincipalsResponse":{ "type":"structure", "members":{ "principals":{ "shape":"PrincipalList", "documentation":"

An array of objects that contain the details about the principals.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "ListReplacePermissionAssociationsWorkRequest":{ "type":"structure", "members":{ "workIds":{ "shape":"ReplacePermissionAssociationsWorkIdList", "documentation":"

A list of IDs. These values come from the `id`field of the `replacePermissionAssociationsWork`structure returned by the ReplacePermissionAssociations operation.

" }, "status":{ "shape":"ReplacePermissionAssociationsWorkStatus", "documentation":"

Specifies that you want to see only the details about requests with a status that matches this value.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" } } }, "ListReplacePermissionAssociationsWorkResponse":{ "type":"structure", "members":{ "replacePermissionAssociationsWorks":{ "shape":"ReplacePermissionAssociationsWorkList", "documentation":"

An array of data structures that provide details of the matching work IDs.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "ListResourceSharePermissionsRequest":{ "type":"structure", "required":["resourceShareArn"], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the resource share for which you want to retrieve the associated permissions.

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" } } }, "ListResourceSharePermissionsResponse":{ "type":"structure", "members":{ "permissions":{ "shape":"ResourceSharePermissionList", "documentation":"

An array of objects that describe the permissions associated with the resource share.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "ListResourceTypesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" }, "resourceRegionScope":{ "shape":"ResourceRegionScopeFilter", "documentation":"

Specifies that you want the results to include only resources that have the specified scope.

- `ALL` – the results include both global and regional resources or resource types.

- `GLOBAL` – the results include only global resources or resource types.

- `REGIONAL` – the results include only regional resources or resource types.

The default value is `ALL`.

" } } }, "ListResourceTypesResponse":{ "type":"structure", "members":{ "resourceTypes":{ "shape":"ServiceNameAndResourceTypeList", "documentation":"

An array of objects that contain information about the resource types that can be shared using RAM.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "ListResourcesRequest":{ "type":"structure", "required":["resourceOwner"], "members":{ "resourceOwner":{ "shape":"ResourceOwner", "documentation":"

Specifies that you want to list only the resource shares that match the following:

- `SELF` – resources that your account shares with other accounts

- `OTHER-ACCOUNTS` – resources that other accounts share with your account

" }, "principal":{ "shape":"String", "documentation":"

Specifies that you want to list only the resource shares that are associated with the specified principal.

" }, "resourceType":{ "shape":"String", "documentation":"

Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

" }, "resourceArns":{ "shape":"ResourceArnList", "documentation":"

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

" }, "resourceShareArns":{ "shape":"ResourceShareArnList", "documentation":"

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

" }, "nextToken":{ "shape":"String", "documentation":"

Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.

" }, "resourceRegionScope":{ "shape":"ResourceRegionScopeFilter", "documentation":"

Specifies that you want the results to include only resources that have the specified scope.

- `ALL` – the results include both global and regional resources or resource types.

- `GLOBAL` – the results include only global resources or resource types.

- `REGIONAL` – the results include only regional resources or resource types.

The default value is `ALL`.

" } } }, "ListResourcesResponse":{ "type":"structure", "members":{ "resources":{ "shape":"ResourceList", "documentation":"

An array of objects that contain information about the resources.

" }, "nextToken":{ "shape":"String", "documentation":"

If present, this value 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`. This indicates that this is the last page of results.

" } } }, "MalformedArnException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

", "error":{"httpStatusCode":400}, "exception":true }, "MalformedPolicyTemplateException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the policy template that you provided isn't valid.

", "error":{"httpStatusCode":400}, "exception":true }, "MaxResults":{ "type":"integer", "max":500, "min":1 }, "MissingRequiredParameterException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because a required input parameter is missing.

", "error":{"httpStatusCode":400}, "exception":true }, "OperationNotPermittedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the requested operation isn't permitted.

", "error":{"httpStatusCode":400}, "exception":true }, "PermissionAlreadyExistsException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because a permission with the specified name already exists in the requested Amazon Web Services Region. Choose a different name.

", "error":{"httpStatusCode":409}, "exception":true }, "PermissionArnList":{ "type":"list", "member":{"shape":"String"} }, "PermissionFeatureSet":{ "type":"string", "enum":[ "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD" ] }, "PermissionLimitExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because it would exceed the maximum number of permissions you can create in each Amazon Web Services Region. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

", "error":{"httpStatusCode":400}, "exception":true }, "PermissionName":{ "type":"string", "max":36, "min":1, "pattern":"[\\w.-]*" }, "PermissionStatus":{ "type":"string", "enum":[ "ATTACHABLE", "UNATTACHABLE", "DELETING", "DELETED" ] }, "PermissionType":{ "type":"string", "enum":[ "CUSTOMER_MANAGED", "AWS_MANAGED" ] }, "PermissionTypeFilter":{ "type":"string", "enum":[ "ALL", "AWS_MANAGED", "CUSTOMER_MANAGED" ] }, "PermissionVersionsLimitExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because it would exceed the limit for the number of versions you can have for a permission. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

", "error":{"httpStatusCode":400}, "exception":true }, "Policy":{"type":"string"}, "PolicyList":{ "type":"list", "member":{"shape":"Policy"} }, "Principal":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the principal that can be associated with a resource share.

" }, "resourceShareArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of a resource share the principal is associated with.

" }, "creationTime":{ "shape":"DateTime", "documentation":"

The date and time when the principal was associated with the resource share.

" }, "lastUpdatedTime":{ "shape":"DateTime", "documentation":"

The date and time when the association between the resource share and the principal was last updated.

" }, "external":{ "shape":"Boolean", "documentation":"

Indicates the relationship between the Amazon Web Services account the principal belongs to and the account that owns the resource share:

- `True` – The two accounts belong to same organization.

- `False` – The two accounts do not belong to the same organization.

" } }, "documentation":"

Describes a principal for use with Resource Access Manager.

" }, "PrincipalArnOrIdList":{ "type":"list", "member":{"shape":"String"} }, "PrincipalList":{ "type":"list", "member":{"shape":"Principal"} }, "PromotePermissionCreatedFromPolicyRequest":{ "type":"structure", "required":[ "permissionArn", "name" ], "members":{ "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the `CREATED_FROM_POLICY` permission that you want to promote. You can get this Amazon Resource Name (ARN) by calling the ListResourceSharePermissions operation.

" }, "name":{ "shape":"String", "documentation":"

Specifies a name for the promoted customer managed permission.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" } } }, "PromotePermissionCreatedFromPolicyResponse":{ "type":"structure", "members":{ "permission":{"shape":"ResourceSharePermissionSummary"}, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "PromoteResourceShareCreatedFromPolicyRequest":{ "type":"structure", "required":["resourceShareArn"], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the resource share to promote.

", "location":"querystring", "locationName":"resourceShareArn" } } }, "PromoteResourceShareCreatedFromPolicyResponse":{ "type":"structure", "members":{ "returnValue":{ "shape":"Boolean", "documentation":"

A return value of `true` indicates that the request succeeded. A value of `false` indicates that the request failed.

" } } }, "RejectResourceShareInvitationRequest":{ "type":"structure", "required":["resourceShareInvitationArn"], "members":{ "resourceShareInvitationArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the invitation that you want to reject.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" } } }, "RejectResourceShareInvitationResponse":{ "type":"structure", "members":{ "resourceShareInvitation":{ "shape":"ResourceShareInvitation", "documentation":"

An object that contains the details about the rejected invitation.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "ReplacePermissionAssociationsRequest":{ "type":"structure", "required":[ "fromPermissionArn", "toPermissionArn" ], "members":{ "fromPermissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the managed permission that you want to replace.

" }, "fromPermissionVersion":{ "shape":"Integer", "documentation":"

Specifies that you want to updated the permissions for only those resource shares that use the specified version of the managed permission.

" }, "toPermissionArn":{ "shape":"String", "documentation":"

Specifies the ARN of the managed permission that you want to associate with resource shares in place of the one specified by `fromPerssionArn` and `fromPermissionVersion`.

The operation always associates the version that is currently the default for the specified managed permission.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" } } }, "ReplacePermissionAssociationsResponse":{ "type":"structure", "members":{ "replacePermissionAssociationsWork":{ "shape":"ReplacePermissionAssociationsWork", "documentation":"

Specifies a data structure that you can use to track the asynchronous tasks that RAM performs to complete this operation. You can use the ListReplacePermissionAssociationsWork operation and pass the `id` value returned in this structure.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "ReplacePermissionAssociationsWork":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The unique identifier for the background task associated with one ReplacePermissionAssociations request.

" }, "fromPermissionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the managed permission that this background task is replacing.

" }, "fromPermissionVersion":{ "shape":"String", "documentation":"

The version of the managed permission that this background task is replacing.

" }, "toPermissionArn":{ "shape":"String", "documentation":"

The ARN of the managed permission that this background task is associating with the resource shares in place of the managed permission and version specified in `fromPermissionArn` and `fromPermissionVersion`.

" }, "toPermissionVersion":{ "shape":"String", "documentation":"

The version of the managed permission that this background task is associating with the resource shares. This is always the version that is currently the default for this managed permission.

" }, "status":{ "shape":"ReplacePermissionAssociationsWorkStatus", "documentation":"

Specifies the current status of the background tasks for the specified ID. The output is one of the following strings:

- `IN_PROGRESS`

- `COMPLETED`

- `FAILED`

" }, "statusMessage":{ "shape":"String", "documentation":"

Specifies the reason for a `FAILED` status. This field is present only when there `status` is `FAILED`.

" }, "creationTime":{ "shape":"DateTime", "documentation":"

The date and time when this asynchronous background task was created.

" }, "lastUpdatedTime":{ "shape":"DateTime", "documentation":"

The date and time when the status of this background task was last updated.

" } }, "documentation":"

A structure that represents the background work that RAM performs when you invoke the ReplacePermissionAssociations operation.

" }, "ReplacePermissionAssociationsWorkIdList":{ "type":"list", "member":{"shape":"String"} }, "ReplacePermissionAssociationsWorkList":{ "type":"list", "member":{"shape":"ReplacePermissionAssociationsWork"} }, "ReplacePermissionAssociationsWorkStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "Resource":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource.

" }, "type":{ "shape":"String", "documentation":"

The resource type. This takes the form of: `service-code`:`resource-code`, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string `ec2:subnet`.

" }, "resourceShareArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource share this resource is associated with.

" }, "resourceGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

" }, "status":{ "shape":"ResourceStatus", "documentation":"

The current status of the resource.

" }, "statusMessage":{ "shape":"String", "documentation":"

A message about the status of the resource.

" }, "creationTime":{ "shape":"DateTime", "documentation":"

The date and time when the resource was associated with the resource share.

" }, "lastUpdatedTime":{ "shape":"DateTime", "documentation":"

The date an time when the association between the resource and the resource share was last updated.

" }, "resourceRegionScope":{ "shape":"ResourceRegionScope", "documentation":"

Specifies the scope of visibility of this resource:

- REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

- GLOBAL – The resource can be accessed from any Amazon Web Services Region.

" } }, "documentation":"

Describes a resource associated with a resource share in RAM.

" }, "ResourceArnList":{ "type":"list", "member":{"shape":"String"} }, "ResourceArnNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified Amazon Resource Name (ARN) was not found.

", "error":{"httpStatusCode":400}, "exception":true }, "ResourceList":{ "type":"list", "member":{"shape":"Resource"} }, "ResourceOwner":{ "type":"string", "enum":[ "SELF", "OTHER-ACCOUNTS" ] }, "ResourceRegionScope":{ "type":"string", "enum":[ "REGIONAL", "GLOBAL" ] }, "ResourceRegionScopeFilter":{ "type":"string", "enum":[ "ALL", "REGIONAL", "GLOBAL" ] }, "ResourceShare":{ "type":"structure", "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource share

" }, "name":{ "shape":"String", "documentation":"

The name of the resource share.

" }, "owningAccountId":{ "shape":"String", "documentation":"

The ID of the Amazon Web Services account that owns the resource share.

" }, "allowExternalPrincipals":{ "shape":"Boolean", "documentation":"

Indicates whether principals outside your organization in Organizations can be associated with a resource share.

- `True` – the resource share can be shared with any Amazon Web Services account.

- `False` – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.

" }, "status":{ "shape":"ResourceShareStatus", "documentation":"

The current status of the resource share.

" }, "statusMessage":{ "shape":"String", "documentation":"

A message about the status of the resource share.

" }, "tags":{ "shape":"TagList", "documentation":"

The tag key and value pairs attached to the resource share.

" }, "creationTime":{ "shape":"DateTime", "documentation":"

The date and time when the resource share was created.

" }, "lastUpdatedTime":{ "shape":"DateTime", "documentation":"

The date and time when the resource share was last updated.

" }, "featureSet":{ "shape":"ResourceShareFeatureSet", "documentation":"

Indicates what features are available for this resource share. This parameter can have one of the following values:

- STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

- CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

- PROMOTING_TO_STANDARD – This resource share was originally `CREATED_FROM_POLICY`, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to `STANDARD` when complete.

" } }, "documentation":"

Describes a resource share in RAM.

" }, "ResourceShareArnList":{ "type":"list", "member":{"shape":"String"} }, "ResourceShareAssociation":{ "type":"structure", "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource share.

" }, "resourceShareName":{ "shape":"String", "documentation":"

The name of the resource share.

" }, "associatedEntity":{ "shape":"String", "documentation":"

The associated entity. This can be either of the following:

- For a resource association, this is the Amazon Resource Name (ARN) of the resource.

- For principal associations, this is one of the following:

  - The ID of an Amazon Web Services account

  - The Amazon Resource Name (ARN) of an organization in Organizations

  - The ARN of an organizational unit (OU) in Organizations

  - The ARN of an IAM role

  - The ARN of an IAM user

" }, "associationType":{ "shape":"ResourceShareAssociationType", "documentation":"

The type of entity included in this association.

" }, "status":{ "shape":"ResourceShareAssociationStatus", "documentation":"

The current status of the association.

" }, "statusMessage":{ "shape":"String", "documentation":"

A message about the status of the association.

" }, "creationTime":{ "shape":"DateTime", "documentation":"

The date and time when the association was created.

" }, "lastUpdatedTime":{ "shape":"DateTime", "documentation":"

The date and time when the association was last updated.

" }, "external":{ "shape":"Boolean", "documentation":"

Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

" } }, "documentation":"

Describes an association between a resource share and either a principal or a resource.

" }, "ResourceShareAssociationList":{ "type":"list", "member":{"shape":"ResourceShareAssociation"} }, "ResourceShareAssociationStatus":{ "type":"string", "enum":[ "ASSOCIATING", "ASSOCIATED", "FAILED", "DISASSOCIATING", "DISASSOCIATED" ] }, "ResourceShareAssociationType":{ "type":"string", "enum":[ "PRINCIPAL", "RESOURCE" ] }, "ResourceShareFeatureSet":{ "type":"string", "enum":[ "CREATED_FROM_POLICY", "PROMOTING_TO_STANDARD", "STANDARD" ] }, "ResourceShareInvitation":{ "type":"structure", "members":{ "resourceShareInvitationArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the invitation.

" }, "resourceShareName":{ "shape":"String", "documentation":"

The name of the resource share.

" }, "resourceShareArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource share

" }, "senderAccountId":{ "shape":"String", "documentation":"

The ID of the Amazon Web Services account that sent the invitation.

" }, "receiverAccountId":{ "shape":"String", "documentation":"

The ID of the Amazon Web Services account that received the invitation.

" }, "invitationTimestamp":{ "shape":"DateTime", "documentation":"

The date and time when the invitation was sent.

" }, "status":{ "shape":"ResourceShareInvitationStatus", "documentation":"

The current status of the invitation.

" }, "resourceShareAssociations":{ "shape":"ResourceShareAssociationList", "documentation":"

To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.

", "deprecated":true, "deprecatedMessage":"This member has been deprecated. Use ListPendingInvitationResources." }, "receiverArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM user or role that received the invitation.

" } }, "documentation":"

Describes an invitation for an Amazon Web Services account to join a resource share.

" }, "ResourceShareInvitationAlreadyAcceptedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified invitation was already accepted.

", "error":{"httpStatusCode":400}, "exception":true }, "ResourceShareInvitationAlreadyRejectedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified invitation was already rejected.

", "error":{"httpStatusCode":400}, "exception":true }, "ResourceShareInvitationArnList":{ "type":"list", "member":{"shape":"String"} }, "ResourceShareInvitationArnNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.

", "error":{"httpStatusCode":400}, "exception":true }, "ResourceShareInvitationExpiredException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified invitation is past its expiration date and time.

", "error":{"httpStatusCode":400}, "exception":true }, "ResourceShareInvitationList":{ "type":"list", "member":{"shape":"ResourceShareInvitation"} }, "ResourceShareInvitationStatus":{ "type":"string", "enum":[ "PENDING", "ACCEPTED", "REJECTED", "EXPIRED" ] }, "ResourceShareLimitExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

", "error":{"httpStatusCode":400}, "exception":true }, "ResourceShareList":{ "type":"list", "member":{"shape":"ResourceShare"} }, "ResourceSharePermissionDetail":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of this RAM managed permission.

" }, "version":{ "shape":"String", "documentation":"

The version of the permission described in this response.

" }, "defaultVersion":{ "shape":"Boolean", "documentation":"

Specifies whether the version of the permission represented in this response is the default version for this permission.

" }, "name":{ "shape":"String", "documentation":"

The name of this permission.

" }, "resourceType":{ "shape":"String", "documentation":"

The resource type to which this permission applies.

" }, "permission":{ "shape":"String", "documentation":"

The permission's effect and actions in JSON format. The `effect` indicates whether the specified actions are allowed or denied. The `actions` list the operations to which the principal is granted or denied access.

" }, "creationTime":{ "shape":"DateTime", "documentation":"

The date and time when the permission was created.

" }, "lastUpdatedTime":{ "shape":"DateTime", "documentation":"

The date and time when the permission was last updated.

" }, "isResourceTypeDefault":{ "shape":"Boolean", "documentation":"

Specifies whether the version of the permission represented in this response is the default version for all resources of this resource type.

" }, "permissionType":{ "shape":"PermissionType", "documentation":"

The type of managed permission. This can be one of the following values:

- `AWS_MANAGED` – Amazon Web Services created and manages this managed permission. You can associate it with your resource shares, but you can't modify it.

- `CUSTOMER_MANAGED` – You, or another principal in your account created this managed permission. You can associate it with your resource shares and create new versions that have different permissions.

" }, "featureSet":{ "shape":"PermissionFeatureSet", "documentation":"

Indicates what features are available for this resource share. This parameter can have one of the following values:

- STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

- CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

- PROMOTING_TO_STANDARD – This resource share was originally `CREATED_FROM_POLICY`, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to `STANDARD` when complete.

" }, "status":{ "shape":"PermissionStatus", "documentation":"

The current status of the association between the permission and the resource share. The following are the possible values:

- `ATTACHABLE` – This permission or version can be associated with resource shares.

- `UNATTACHABLE` – This permission or version can't currently be associated with resource shares.

- `DELETING` – This permission or version is in the process of being deleted.

- `DELETED` – This permission or version is deleted.

" }, "tags":{ "shape":"TagList", "documentation":"

The tag key and value pairs attached to the resource share.

" } }, "documentation":"

Information about a RAM managed permission.

" }, "ResourceSharePermissionList":{ "type":"list", "member":{"shape":"ResourceSharePermissionSummary"} }, "ResourceSharePermissionSummary":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the permission you want information about.

" }, "version":{ "shape":"String", "documentation":"

The version of the permission associated with this resource share.

" }, "defaultVersion":{ "shape":"Boolean", "documentation":"

Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.

" }, "name":{ "shape":"String", "documentation":"

The name of this managed permission.

" }, "resourceType":{ "shape":"String", "documentation":"

The type of resource to which this permission applies. This takes the form of: `service-code`:`resource-code`, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string `ec2:subnet`.

" }, "status":{ "shape":"String", "documentation":"

The current status of the permission.

" }, "creationTime":{ "shape":"DateTime", "documentation":"

The date and time when the permission was created.

" }, "lastUpdatedTime":{ "shape":"DateTime", "documentation":"

The date and time when the permission was last updated.

" }, "isResourceTypeDefault":{ "shape":"Boolean", "documentation":"

Specifies whether the managed permission associated with this resource share is the default managed permission for all resources of this resource type.

" }, "permissionType":{ "shape":"PermissionType", "documentation":"

The type of managed permission. This can be one of the following values:

- `AWS_MANAGED` – Amazon Web Services created and manages this managed permission. You can associate it with your resource shares, but you can't modify it.

- `CUSTOMER_MANAGED` – You, or another principal in your account created this managed permission. You can associate it with your resource shares and create new versions that have different permissions.

" }, "featureSet":{ "shape":"PermissionFeatureSet", "documentation":"

Indicates what features are available for this resource share. This parameter can have one of the following values:

- STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

- CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

- PROMOTING_TO_STANDARD – This resource share was originally `CREATED_FROM_POLICY`, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to `STANDARD` when complete.

" }, "tags":{ "shape":"TagList", "documentation":"

A list of the tag key value pairs currently attached to the permission.

" } }, "documentation":"

Information about an RAM permission.

" }, "ResourceShareStatus":{ "type":"string", "enum":[ "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED" ] }, "ResourceStatus":{ "type":"string", "enum":[ "AVAILABLE", "ZONAL_RESOURCE_INACCESSIBLE", "LIMIT_EXCEEDED", "UNAVAILABLE", "PENDING" ] }, "ServerInternalException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

", "error":{"httpStatusCode":500}, "exception":true }, "ServiceNameAndResourceType":{ "type":"structure", "members":{ "resourceType":{ "shape":"String", "documentation":"

The type of the resource. This takes the form of: `service-code`:`resource-code`, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string `ec2:subnet`.

" }, "serviceName":{ "shape":"String", "documentation":"

The name of the Amazon Web Services service to which resources of this type belong.

" }, "resourceRegionScope":{ "shape":"ResourceRegionScope", "documentation":"

Specifies the scope of visibility of resources of this type:

- REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.

- GLOBAL – The resource can be accessed from any Amazon Web Services Region.

" } }, "documentation":"

Information about a shareable resource type and the Amazon Web Services service to which resources of that type belong.

" }, "ServiceNameAndResourceTypeList":{ "type":"list", "member":{"shape":"ServiceNameAndResourceType"} }, "ServiceUnavailableException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the service isn't available. Try again later.

", "error":{"httpStatusCode":503}, "exception":true }, "SetDefaultPermissionVersionRequest":{ "type":"structure", "required":[ "permissionArn", "permissionVersion" ], "members":{ "permissionArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the customer managed permission whose default version you want to change.

" }, "permissionVersion":{ "shape":"Integer", "documentation":"

Specifies the version number that you want to designate as the default for customer managed permission. To see a list of all available version numbers, use ListPermissionVersions.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" } } }, "SetDefaultPermissionVersionResponse":{ "type":"structure", "members":{ "returnValue":{ "shape":"Boolean", "documentation":"

A boolean value that indicates whether the operation was successful.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } }, "SourceArnOrAccountList":{ "type":"list", "member":{"shape":"String"} }, "String":{"type":"string"}, "Tag":{ "type":"structure", "members":{ "key":{ "shape":"TagKey", "documentation":"

The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

" }, "value":{ "shape":"TagValue", "documentation":"

The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

" } }, "documentation":"

A structure containing a tag. A tag is metadata that you can attach to your resources to help organize and categorize them. You can also use them to help you secure your resources. For more information, see Controlling access to Amazon Web Services resources using tags.

For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" }, "TagFilter":{ "type":"structure", "members":{ "tagKey":{ "shape":"TagKey", "documentation":"

The tag key. This must have a valid string value and can't be empty.

" }, "tagValues":{ "shape":"TagValueList", "documentation":"

A list of zero or more tag values. If no values are provided, then the filter matches any tag with the specified key, regardless of its value.

" } }, "documentation":"

A tag key and optional list of possible values that you can use to filter results for tagged resources.

" }, "TagFilters":{ "type":"list", "member":{"shape":"TagFilter"} }, "TagKey":{"type":"string"}, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagLimitExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because it would exceed the limit for tags for your Amazon Web Services account.

", "error":{"httpStatusCode":400}, "exception":true }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagPolicyViolationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because the specified tag key is a reserved word and can't be used.

", "error":{"httpStatusCode":400}, "exception":true }, "TagResourceRequest":{ "type":"structure", "required":["tags"], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the resource share that you want to add tags to. You must specify either `resourceShareArn`, or `resourceArn`, but not both.

" }, "tags":{ "shape":"TagList", "documentation":"

A list of one or more tag key and value pairs. The tag key must be present and not be an empty string. The tag value must be present but can be an empty string.

" }, "resourceArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the managed permission that you want to add tags to. You must specify either `resourceArn`, or `resourceShareArn`, but not both.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{"type":"string"}, "TagValueList":{ "type":"list", "member":{"shape":"TagValue"} }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because it exceeded the rate at which you are allowed to perform this operation. Please try again later.

", "error":{"httpStatusCode":429}, "exception":true }, "UnknownResourceException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The operation failed because a specified resource couldn't be found.

", "error":{"httpStatusCode":400}, "exception":true }, "UnmatchedPolicyPermissionException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

There isn't an existing managed permission defined in RAM that has the same IAM permissions as the resource-based policy attached to the resource. You should first run PromotePermissionCreatedFromPolicy to create that managed permission.

", "error":{"httpStatusCode":400}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":["tagKeys"], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the resource share that you want to remove tags from. The tags are removed from the resource share, not the resources in the resource share. You must specify either `resourceShareArn`, or `resourceArn`, but not both.

" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

Specifies a list of one or more tag keys that you want to remove.

" }, "resourceArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the managed permission that you want to remove tags from. You must specify either `resourceArn`, or `resourceShareArn`, but not both.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateResourceShareRequest":{ "type":"structure", "required":["resourceShareArn"], "members":{ "resourceShareArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the resource share that you want to modify.

" }, "name":{ "shape":"String", "documentation":"

If specified, the new name that you want to attach to the resource share.

" }, "allowExternalPrincipals":{ "shape":"Boolean", "documentation":"

Specifies whether principals outside your organization in Organizations can be associated with a resource share.

" }, "clientToken":{ "shape":"String", "documentation":"

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.

" } } }, "UpdateResourceShareResponse":{ "type":"structure", "members":{ "resourceShare":{ "shape":"ResourceShare", "documentation":"

Information about the resource share.

" }, "clientToken":{ "shape":"String", "documentation":"

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the `clientToken` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

" } } } }, "documentation":"

This is the Resource Access Manager API Reference. This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources to other Amazon Web Services accounts. If you use Organizations to manage your accounts, then you can share your resources with your entire organization or to organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles and users.

To learn more about RAM, see the following resources:

- Resource Access Manager product page

- Resource Access Manager User Guide

" }