{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.ram#AcceptResourceShareInvitation": { "type": "operation", "input": { "target": "com.amazonaws.ram#AcceptResourceShareInvitationRequest" }, "output": { "target": "com.amazonaws.ram#AcceptResourceShareInvitationResponse" }, "errors": [ { "target": "com.amazonaws.ram#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.ram#InvalidClientTokenException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#OperationNotPermittedException" }, { "target": "com.amazonaws.ram#ResourceShareInvitationAlreadyAcceptedException" }, { "target": "com.amazonaws.ram#ResourceShareInvitationAlreadyRejectedException" }, { "target": "com.amazonaws.ram#ResourceShareInvitationArnNotFoundException" }, { "target": "com.amazonaws.ram#ResourceShareInvitationExpiredException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "
Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the\n invitation, the resources included in the resource share are available to interact with in the\n relevant Amazon Web Services Management Consoles and tools.
", "smithy.api#http": { "method": "POST", "uri": "/acceptresourceshareinvitation", "code": 200 } } }, "com.amazonaws.ram#AcceptResourceShareInvitationRequest": { "type": "structure", "members": { "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the invitation that you want to accept.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
An object that contains information about the specified invitation.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
This is the Resource Access Manager API Reference. This documentation provides\n descriptions and syntax for each of the actions and data types in RAM. RAM is a\n service that helps you securely share your Amazon Web Services resources to other Amazon Web Services accounts. If\n you use Organizations to manage your accounts, then you can share your resources with your\n entire organization or to organizational units (OUs). For supported resource types, you\n can also share resources with individual Identity and Access Management (IAM) roles and users.
\nTo learn more about RAM, see the following resources:
\nAdds the specified list of principals, resources, and source constraints to a resource share. Principals that\n already have access to this resource share immediately receive access to the added resources.\n Newly added principals immediately receive access to the resources shared in this resource share.
", "smithy.api#http": { "method": "POST", "uri": "/associateresourceshare", "code": 200 } } }, "com.amazonaws.ram#AssociateResourceSharePermission": { "type": "operation", "input": { "target": "com.amazonaws.ram#AssociateResourceSharePermissionRequest" }, "output": { "target": "com.amazonaws.ram#AssociateResourceSharePermissionResponse" }, "errors": [ { "target": "com.amazonaws.ram#InvalidClientTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#OperationNotPermittedException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "Adds or replaces the RAM permission for a resource type included in a resource share. You can\n have exactly one permission associated with each resource type in the resource share. You can add\n a new RAM permission only if there are currently no resources of that resource type\n currently in the resource share.
", "smithy.api#http": { "method": "POST", "uri": "/associateresourcesharepermission", "code": 200 } } }, "com.amazonaws.ram#AssociateResourceSharePermissionRequest": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace\n permissions.
", "smithy.api#required": {} } }, "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share.\n To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and \n then choose the name of the permission. The ARN is displayed on the detail page.
", "smithy.api#required": {} } }, "permissionTemplateParameters": { "target": "com.amazonaws.ram#PermissionTemplateParameterInputList", "traits": { "smithy.api#documentation": "Specifies the template parameter values for the permission being associated. You must\n provide values for all parameters declared in the permission template. This parameter is\n required only if the specified permission has template parameters.
" } }, "replace": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the specified permission should replace the existing permission\n associated with the resource share. Use true to replace the current permissions. Use\n false to add the permission to a resource share that currently doesn't\n 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\n permission for the specified resource type and you don't set replace to\n true then the operation returns an error. This helps prevent\n accidental overwriting of a permission.
Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies the version of the RAM permission to associate with the resource share. You can\n specify only the version that is currently set as the default\n version for the permission. If you also set the replace pararameter to\n true, then this operation updates an outdated version of the permission\n to the current default version.
You don't need to specify this parameter because the default behavior is to use\n the version that is currently set as the default version for the permission. This\n parameter is supported for backwards compatibility.
\nA return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.
The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources\n to.
", "smithy.api#required": {} } }, "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { "smithy.api#documentation": "Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be\n null if you want to add only principals.
Specifies a list of principals to whom you want to the resource share. This can be\n null if you want to add only resources.
What the principals can do with the resources in the share is determined by the RAM\n permissions that you associate with the resource share. See AssociateResourceSharePermission.
\nYou can include the following values:
\nAn Amazon Web Services account ID, for example: 123456789012\n
An Amazon Resource Name (ARN) of an organization in Organizations, for example:\n organizations::123456789012:organization/o-exampleorgid\n
An ARN of an organizational unit (OU) in Organizations, for example:\n organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123\n
An ARN of an IAM role, for example:\n iam::123456789012:role/rolename\n
An ARN of an IAM user, for example:\n iam::123456789012user/username\n
A service principal name, for example: service-id.amazonaws.com\n
Not all resource types can be shared with IAM roles and users. \n For more information, see Sharing with IAM roles and users in the Resource Access Manager User\n Guide.
\nSpecifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) that limit when service principals can access resources in this resource share. When a service principal attempts to access a shared resource, validation is performed to ensure the request originates from one of the specified sources. This helps prevent confused deputy attacks by applying constraints on where service principals can access resources from.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ram#AssociateResourceShareResponse": { "type": "structure", "members": { "resourceShareAssociations": { "target": "com.amazonaws.ram#ResourceShareAssociationList", "traits": { "smithy.api#documentation": "An array of objects that contain information about the associations.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
The Amazon Resource Name (ARN) of the associated managed permission.
" } }, "permissionVersion": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The version of the permission currently associated with the resource share.
" } }, "defaultVersion": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the associated resource share is using the default version of the\n permission.
" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The resource type to which this permission applies.
" } }, "status": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The current status of the association between the permission and the resource share.\n The following are the possible values:
\n\n ATTACHABLE \u2013 This permission or version can be associated \n with resource shares.
\n UNATTACHABLE \u2013 This permission or version can't \n currently be associated with resource shares.
\n DELETING \u2013 This permission or version is in the process of\n being deleted.
\n DELETED \u2013 This permission or version is deleted.
\n DEPRECATED \u2013 The permission owner deprecated this permission. It can't be associated with new resource shares, but existing\n associations continue to function.
Indicates what features are available for this resource share. This parameter can have one of\n the following values:
\n\n STANDARD \u2013 A resource share that supports all\n functionality. These resource shares are visible to all principals you share the resource share with. \n You can modify these resource shares in RAM using the console or APIs. This resource share might \n have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
\n\n CREATED_FROM_POLICY \u2013 The customer\n manually shared a resource by attaching a resource-based policy. That policy did\n not match any existing managed permissions, so RAM created this customer managed permission automatically on the\n customer's behalf based on the attached policy document. This type of resource share \n is visible only to the Amazon Web Services account that created it. You can't modify it in \n RAM unless you promote it. For more information, \n see PromoteResourceShareCreatedFromPolicy.
\n\n PROMOTING_TO_STANDARD \u2013 This\n resource share was originally CREATED_FROM_POLICY, but the customer ran\n the PromoteResourceShareCreatedFromPolicy and that operation\n is still in progress. This value changes to STANDARD when\n complete.
The date and time when the association between the permission and the resource share\n was last updated.
" } }, "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a resource share associated with this permission.
" } }, "permissionTemplateParameters": { "target": "com.amazonaws.ram#PermissionTemplateParameterList", "traits": { "smithy.api#documentation": "The template parameter values provided when the permission was associated with this\n resource share. If the permission has no declared template parameters, this member doesn't appear in the response.
" } } }, "traits": { "smithy.api#documentation": "An object that describes a managed permission associated with a resource share.
" } }, "com.amazonaws.ram#AssociatedPermissionList": { "type": "list", "member": { "target": "com.amazonaws.ram#AssociatedPermission", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#AssociatedSource": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource share that contains the source association.
" } }, "sourceId": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The identifier of the source. This can be an account ID, Amazon Resource Name (ARN), organization ID, or organization path.
" } }, "sourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The type of source.
" } }, "status": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The current status of the source association.
" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the source association was last updated.
" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the source association was created.
" } }, "statusMessage": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "A message about the status of the source association.
" } } }, "traits": { "smithy.api#documentation": "Information about a source association in a resource share. Source associations control which sources can be used with service principals.
" } }, "com.amazonaws.ram#AssociatedSourceList": { "type": "list", "member": { "target": "com.amazonaws.ram#AssociatedSource", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#Boolean": { "type": "boolean" }, "com.amazonaws.ram#CreatePermission": { "type": "operation", "input": { "target": "com.amazonaws.ram#CreatePermissionRequest" }, "output": { "target": "com.amazonaws.ram#CreatePermissionResponse" }, "errors": [ { "target": "com.amazonaws.ram#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.ram#InvalidClientTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#InvalidPolicyException" }, { "target": "com.amazonaws.ram#MalformedPolicyTemplateException" }, { "target": "com.amazonaws.ram#OperationNotPermittedException" }, { "target": "com.amazonaws.ram#PermissionAlreadyExistsException" }, { "target": "com.amazonaws.ram#PermissionLimitExceededException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "Creates a customer managed permission for a specified resource type that you can attach to resource shares.\n It is created in the Amazon Web Services Region in which you call the operation.
", "smithy.api#http": { "method": "POST", "uri": "/createpermission", "code": 200 } } }, "com.amazonaws.ram#CreatePermissionRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ram#PermissionName", "traits": { "smithy.api#documentation": "Specifies the name of the customer managed permission. The name must be unique within the\n Amazon Web Services Region.
", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the name of the resource type that this customer managed permission applies to.
\nThe format is\n \n \n and is case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the\n string ec2:Subnet. To see the list of valid values for this parameter,\n query the ListResourceTypes operation. This value must match the display name of the resource \n (available in ListResourceTypes).
A string in JSON format string that contains the following elements of a\n resource-based policy:
\n\n Effect: must be set to\n ALLOW.
\n Action: specifies the actions that are\n allowed by this customer managed permission. The list must contain only actions that are supported by\n the specified resource type. For a list of all actions supported by each\n resource type, see Actions, resources, and condition keys for Amazon Web Services services in the\n Identity and Access Management User Guide.
\n\n Condition: (optional) specifies conditional \n parameters that must evaluate to true when a user attempts an action for that \n action to be allowed. For more information about the Condition element, see \n IAM\n policies: Condition element in the Identity and Access Management User\n Guide.
\nThis template can't include either the Resource or\n Principal elements. Those are both filled in by RAM when it instantiates \n the resource-based policy on each resource shared using this managed permission. The \n Resource comes from the ARN of the specific resource that you are sharing. \n The Principal comes from the list of identities added to the resource \n share.
Specifies a list of template parameter declarations for this permission. Each\n declaration defines a named placeholder that can be used in the policy template using\n the syntax @{parameterName}. Template parameters can only appear in\n Condition Key and Condition Value fields of the policy. When you associate this permission with a resource share, you must provide values for all declared parameters.
Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies a list of one or more tag key and value pairs to attach to the\n permission.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ram#CreatePermissionResponse": { "type": "structure", "members": { "permission": { "target": "com.amazonaws.ram#ResourceSharePermissionSummary", "traits": { "smithy.api#documentation": "A structure with information about this customer managed permission.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
Creates a new version of the specified customer managed permission. The new version is automatically set as\n the default version of the customer managed permission. New resource shares automatically use the default\n permission. Existing resource shares continue to use their original permission versions,\n but you can use ReplacePermissionAssociations to update them.
\nIf the specified customer managed permission already has the maximum of 5 versions, then\n you must delete one of the existing versions before you can create a new one.
", "smithy.api#http": { "method": "POST", "uri": "/createpermissionversion", "code": 200 } } }, "com.amazonaws.ram#CreatePermissionVersionRequest": { "type": "structure", "members": { "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the customer managed permission you're creating a new version for.
", "smithy.api#required": {} } }, "policyTemplate": { "target": "com.amazonaws.ram#Policy", "traits": { "smithy.api#documentation": "A string in JSON format string that contains the following elements of a\n resource-based policy:
\n\n Effect: must be set to\n ALLOW.
\n Action: specifies the actions that are\n allowed by this customer managed permission. The list must contain only actions that are supported by\n the specified resource type. For a list of all actions supported by each\n resource type, see Actions, resources, and condition keys for Amazon Web Services services in the\n Identity and Access Management User Guide.
\n\n Condition: (optional) specifies conditional \n parameters that must evaluate to true when a user attempts an action for that \n action to be allowed. For more information about the Condition element, see \n IAM\n policies: Condition element in the Identity and Access Management User\n Guide.
\nThis template can't include either the Resource or\n Principal elements. Those are both filled in by RAM when it instantiates \n the resource-based policy on each resource shared using this managed permission. The \n Resource comes from the ARN of the specific resource that you are sharing. \n The Principal comes from the list of identities added to the resource \n share.
Specifies a list of template parameter declarations for this version of the\n permission. Each declaration defines a named placeholder that can be used in the policy\n template. Because each version is independent, you can define the same or\n a different set of template parameters for each version.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
The details of the new permission version, including its Amazon Resource Name (ARN), version number, status, and policy document.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you\n want to share, a list of principals you want to share the resources with, the\n permissions to grant those principals, and optionally source constraints to enhance security for service principal sharing.
\nSharing a resource makes it available for use by principals outside of the\n Amazon Web Services account that created the resource. Sharing doesn't change any permissions or\n quotas that apply to the resource in the account that created it.
\nSpecifies the name of the resource share.
", "smithy.api#required": {} } }, "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { "smithy.api#documentation": "Specifies a list of one or more ARNs of the resources to associate with the\n resource share.
" } }, "principals": { "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { "smithy.api#documentation": "Specifies a list of one or more principals to associate with the resource share.
\nYou can include the following values:
\nAn Amazon Web Services account ID, for example: 123456789012\n
An Amazon Resource Name (ARN) of an organization in Organizations, for example:\n organizations::123456789012:organization/o-exampleorgid\n
An ARN of an organizational unit (OU) in Organizations, for example:\n organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123\n
An ARN of an IAM role, for example:\n iam::123456789012:role/rolename\n
An ARN of an IAM user, for example:\n iam::123456789012user/username\n
A service principal name, for example: service-id.amazonaws.com\n
Not all resource types can be shared with IAM roles and users. \n For more information, see Sharing with IAM roles and users in the Resource Access Manager User\n Guide.
\nSpecifies one or more tags to attach to the resource share itself. It doesn't attach the tags to\n the resources associated with the resource share.
" } }, "allowExternalPrincipals": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Specifies whether principals outside your organization in Organizations can be associated\n with a resource share. A value of true lets you share with individual Amazon Web Services accounts\n that are not in your organization. A value of false\n only has meaning if your account is a member of an Amazon Web Services Organization. The default value\n is true.
Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do\n not specify an ARN for the permission, RAM automatically attaches the default version\n of the permission for each resource type. You can associate only one permission with\n each resource type included in the resource share.
" } }, "sources": { "target": "com.amazonaws.ram#SourceArnOrAccountList", "traits": { "smithy.api#documentation": "Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) that limit when service principals can access resources in this resource share. When a service principal attempts to access a shared resource, validation is performed to ensure the request originates from one of the specified sources. This helps prevent confused deputy attacks by applying constraints on where service principals can access resources from.
" } }, "permissionTemplateParameters": { "target": "com.amazonaws.ram#PermissionArnAndTemplateParametersList", "traits": { "smithy.api#documentation": "Specifies the template parameter values for each permission being associated that has\n template parameters. Each entry maps a permission ARN to the parameter values to use\n when rendering the permission template for this resource share. You must provide values for all\n parameters declared in each permission template.
" } }, "resourceShareConfiguration": { "target": "com.amazonaws.ram#ResourceShareConfiguration", "traits": { "smithy.api#documentation": "Specifies the configuration of this resource share.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ram#CreateResourceShareResponse": { "type": "structure", "members": { "resourceShare": { "target": "com.amazonaws.ram#ResourceShare", "traits": { "smithy.api#documentation": "An object with information about the new resource share.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You\n can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all\n versions associated with the customer managed permission.
", "smithy.api#http": { "method": "DELETE", "uri": "/deletepermission", "code": 200 } } }, "com.amazonaws.ram#DeletePermissionRequest": { "type": "structure", "members": { "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the customer managed permission that you want to delete.
", "smithy.api#httpQuery": "permissionArn", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
A boolean that indicates whether the delete operations succeeded.
", "smithy.api#xmlName": "return" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
This operation is performed asynchronously, and this response parameter indicates the\n current status.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ram#DeletePermissionVersion": { "type": "operation", "input": { "target": "com.amazonaws.ram#DeletePermissionVersionRequest" }, "output": { "target": "com.amazonaws.ram#DeletePermissionVersionResponse" }, "errors": [ { "target": "com.amazonaws.ram#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.ram#InvalidClientTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#OperationNotPermittedException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "Deletes one version of a customer managed permission. The version you specify must not be attached to any\n resource share and must not be the default version for the permission.
\nIf a customer managed permission has the maximum of 5 versions, then you must delete at\n least one version before you can create another.
", "smithy.api#http": { "method": "DELETE", "uri": "/deletepermissionversion", "code": 200 } } }, "com.amazonaws.ram#DeletePermissionVersionRequest": { "type": "structure", "members": { "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the permission with the version you want to delete.
", "smithy.api#httpQuery": "permissionArn", "smithy.api#required": {} } }, "permissionVersion": { "target": "com.amazonaws.ram#Integer", "traits": { "smithy.api#documentation": "Specifies the version number to delete.
\nYou can't delete the default version for a customer managed permission.
\nYou can't delete a version if it's the only version of the permission. You must either\n first create another version, or delete the permission completely.
\nYou can't delete a version if it is attached to any resource shares. If the version is\n the default, you must first use SetDefaultPermissionVersion to set a\n different version as the default for the customer managed permission, and then use AssociateResourceSharePermission to update your resource shares to use\n the new default version.
", "smithy.api#httpQuery": "permissionVersion", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
A boolean value that indicates whether the operation is successful.
", "smithy.api#xmlName": "return" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
This operation is performed asynchronously, and this response parameter indicates the\n current status.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ram#DeleteResourceShare": { "type": "operation", "input": { "target": "com.amazonaws.ram#DeleteResourceShareRequest" }, "output": { "target": "com.amazonaws.ram#DeleteResourceShareResponse" }, "errors": [ { "target": "com.amazonaws.ram#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.ram#InvalidClientTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#InvalidStateTransitionException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#OperationNotPermittedException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#ThrottlingException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "Deletes the specified resource share.
\nThis doesn't delete any of the resources that were associated with the resource share; it\n only stops the sharing of those resources through this resource share.
\nSpecifies the Amazon Resource Name (ARN) of the resource share to delete.
", "smithy.api#httpQuery": "resourceShareArn", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.
The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
Removes the specified principals, resources, or source constraints from participating in the specified\n resource share.
", "smithy.api#http": { "method": "POST", "uri": "/disassociateresourceshare", "code": 200 } } }, "com.amazonaws.ram#DisassociateResourceSharePermission": { "type": "operation", "input": { "target": "com.amazonaws.ram#DisassociateResourceSharePermissionRequest" }, "output": { "target": "com.amazonaws.ram#DisassociateResourceSharePermissionResponse" }, "errors": [ { "target": "com.amazonaws.ram#InvalidClientTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#InvalidStateTransitionException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#OperationNotPermittedException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "Removes a managed permission from a resource share. Permission changes take effect immediately. You can\n remove a managed permission from a resource share only if there are currently no resources of the relevant\n resource type currently attached to the resource share.
", "smithy.api#http": { "method": "POST", "uri": "/disassociateresourcesharepermission", "code": 200 } } }, "com.amazonaws.ram#DisassociateResourceSharePermissionRequest": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource share that you want to remove the managed permission from.
", "smithy.api#required": {} } }, "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the managed permission to disassociate from the resource share. Changes to permissions take\n effect immediately.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.
The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
Specifies Amazon Resource Name (ARN) of the resource share that you want to remove resources or principals\n from.
", "smithy.api#required": {} } }, "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { "smithy.api#documentation": "Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from\n the resource share. After the operation runs, these resources are no longer shared with principals\n associated with the resource share.
" } }, "principals": { "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { "smithy.api#documentation": "Specifies a list of one or more principals that no longer are to have access to the\n resources in this resource share.
\nYou can include the following values:
\nAn Amazon Web Services account ID, for example: 123456789012\n
An Amazon Resource Name (ARN) of an organization in Organizations, for example:\n organizations::123456789012:organization/o-exampleorgid\n
An ARN of an organizational unit (OU) in Organizations, for example:\n organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123\n
An ARN of an IAM role, for example:\n iam::123456789012:role/rolename\n
An ARN of an IAM user, for example:\n iam::123456789012user/username\n
A service principal name, for example: service-id.amazonaws.com\n
Not all resource types can be shared with IAM roles and users. \n For more information, see Sharing with IAM roles and users in the Resource Access Manager User\n Guide.
\nSpecifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) to remove from the resource share. This enables granular management of source constraints while maintaining service principal associations. At least one source must remain when service principals are present.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ram#DisassociateResourceShareResponse": { "type": "structure", "members": { "resourceShareAssociations": { "target": "com.amazonaws.ram#ResourceShareAssociationList", "traits": { "smithy.api#documentation": "An array of objects with information about the updated associations for this\n resource share.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
Enables resource sharing within your organization in Organizations. This operation creates\n a service-linked role called AWSServiceRoleForResourceAccessManager that has the IAM managed policy\n named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about\n the organization and its structure. This lets you share resources with all of the\n accounts in the calling account's organization by specifying the organization ID, or all\n of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable\n sharing within the organization, you can specify only individual Amazon Web Services accounts, or for\n supported resource types, IAM roles and users.
You must call this operation from an IAM role or user in the organization's\n management account.
\n ", "smithy.api#http": { "method": "POST", "uri": "/enablesharingwithawsorganization", "code": 200 } } }, "com.amazonaws.ram#EnableSharingWithAwsOrganizationRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ram#EnableSharingWithAwsOrganizationResponse": { "type": "structure", "members": { "returnValue": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.
Retrieves the contents of a managed permission in JSON format.
\nIf the permission has template parameters, you can include the\n permissionTemplateParameters parameter in your request. The operation then\n renders the returned policy with the specified values in place of the template parameter\n placeholders. If you omit permissionTemplateParameters, the operation\n returns the raw policy template with @{parameterName} placeholders\n unchanged.
Specifies the Amazon Resource Name (ARN) of the permission whose contents you want to retrieve.\n To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and \n then choose the name of the permission. The ARN is displayed on the detail page.
", "smithy.api#required": {} } }, "permissionVersion": { "target": "com.amazonaws.ram#Integer", "traits": { "smithy.api#documentation": "Specifies the version number of the RAM permission to retrieve. If you don't specify\n this parameter, the operation retrieves the default version.
\nTo see the list of available versions, use ListPermissionVersions.
" } }, "permissionTemplateParameters": { "target": "com.amazonaws.ram#PermissionTemplateParameterInputList", "traits": { "smithy.api#documentation": "Specifies the template parameter values to use when rendering the permission's policy\n template. Each entry supplies a parameter name and its values. When you provide this\n parameter, the response contains the rendered policy with the specified values\n in place of the template parameter placeholders.
\nFor STRING type parameters, provide a single value. For\n STRING_LIST type parameters, provide one or more values.
You can specify this parameter only for permissions that declare template parameters.\n You must provide values for all parameters declared in the permission template.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ram#GetPermissionResponse": { "type": "structure", "members": { "permission": { "target": "com.amazonaws.ram#ResourceSharePermissionDetail", "traits": { "smithy.api#documentation": "An object with details about the permission.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ram#GetResourcePolicies": { "type": "operation", "input": { "target": "com.amazonaws.ram#GetResourcePoliciesRequest" }, "output": { "target": "com.amazonaws.ram#GetResourcePoliciesResponse" }, "errors": [ { "target": "com.amazonaws.ram#InvalidNextTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#ResourceArnNotFoundException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "Retrieves the resource policies for the specified resources that you own and have\n shared.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.
", "smithy.api#required": {} } }, "principal": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the principal.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
An array of resource policy documents in JSON format.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Retrieves the lists of resources and principals that associated for resource shares that you\n own.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies whether you want to retrieve the associations that involve a specified\n resource or principal.
\n\n PRINCIPAL \u2013 list the principals whose associations you\n want to see.
\n RESOURCE \u2013 list the resources whose associations you want\n to see.
Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to\n retrieve.
" } }, "resourceArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.
\nYou cannot specify this parameter if the association type is\n PRINCIPAL.
Specifies the ID of the principal whose resource shares you want to retrieve. This can be an\n Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resource Name (ARN) of an\n individual IAM role or user.
\nYou cannot specify this parameter if the association type is\n RESOURCE.
Specifies that you want to retrieve only associations that have this status.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
An array of objects that contain the details about the associations.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Retrieves details about invitations that you have received for resource shares.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.
" } }, "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { "smithy.api#documentation": "Specifies that you want details about invitations only for the resource shares described by this\n list of Amazon Resource Names (ARNs)\n
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
An array of objects that contain the details about the invitations.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Retrieves details about the resource shares that you own or that are shared with you.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.
" } }, "resourceShareStatus": { "target": "com.amazonaws.ram#ResourceShareStatus", "traits": { "smithy.api#documentation": "Specifies that you want to retrieve details of only those resource shares that have this\n status.
" } }, "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { "smithy.api#documentation": "Specifies that you want to retrieve details of only those resource shares that match the\n following:
\n\n \n SELF\n \u2013 resource shares that your\n account shares with other accounts
\n \n OTHER-ACCOUNTS\n \u2013 resource shares\n that other accounts share with your account
Specifies the name of an individual resource share that you want to retrieve details\n about.
" } }, "tagFilters": { "target": "com.amazonaws.ram#TagFilters", "traits": { "smithy.api#documentation": "Specifies that you want to retrieve details of only those resource shares that match the\n specified tag keys and values.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
Specifies that you want to retrieve details of only those resource shares that use the managed permission with\n this Amazon Resource Name (ARN).
" } }, "permissionVersion": { "target": "com.amazonaws.ram#Integer", "traits": { "smithy.api#documentation": "Specifies that you want to retrieve details for only those resource shares that use the\n specified version of the managed permission.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ram#GetResourceSharesResponse": { "type": "structure", "members": { "resourceShares": { "target": "com.amazonaws.ram#ResourceShareList", "traits": { "smithy.api#documentation": "An array of objects that contain the information about the resource shares.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
The operation failed because the client token input parameter matched one that was\n used with a previous call to the operation, but at least one of the other input\n parameters is different from the previous call.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#Integer": { "type": "integer" }, "com.amazonaws.ram#InvalidClientTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidClientToken", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified client token isn't valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#InvalidMaxResultsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidMaxResults", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified value for MaxResults isn't\n valid.
The operation failed because the specified value for NextToken isn't\n valid. You must specify a value you received in the NextToken response of a\n previous call to this operation.
The operation failed because a parameter you specified isn't valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#InvalidPolicyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidPolicy", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because a policy you specified isn't valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#InvalidResourceTypeException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidResourceType.Unknown", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified resource type isn't valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#InvalidStateTransitionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidStateTransitionException.Unknown", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the requested operation isn't valid for the resource\n share in its current state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#ListPendingInvitationResources": { "type": "operation", "input": { "target": "com.amazonaws.ram#ListPendingInvitationResourcesRequest" }, "output": { "target": "com.amazonaws.ram#ListPendingInvitationResourcesResponse" }, "errors": [ { "target": "com.amazonaws.ram#InvalidNextTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#MissingRequiredParameterException" }, { "target": "com.amazonaws.ram#ResourceShareInvitationAlreadyRejectedException" }, { "target": "com.amazonaws.ram#ResourceShareInvitationArnNotFoundException" }, { "target": "com.amazonaws.ram#ResourceShareInvitationExpiredException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "Lists the resources in a resource share that is shared with you but for which the invitation is\n still PENDING. That means that you haven't accepted or rejected the\n invitation and the invitation hasn't expired.
Always check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies the Amazon Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
Specifies that you want the results to include only \n resources that have the specified scope.
\n\n ALL \u2013 the results include both global and \n regional resources or resource types.
\n GLOBAL \u2013 the results include only global \n resources or resource types.
\n REGIONAL \u2013 the results include only regional \n resources or resource types.
The default value is ALL.
An array of objects that contain the information about the resources included the\n specified resource share.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists information about the managed permission and its associations to any resource shares that use\n this managed permission. This lets you see which resource shares use which versions of the specified\n managed permission.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies the Amazon Resource Name (ARN) of the managed permission.
" } }, "permissionVersion": { "target": "com.amazonaws.ram#Integer", "traits": { "smithy.api#documentation": "Specifies that you want to list only those associations with resource shares that use this\n version of the managed permission. If you don't provide a value for this parameter, then the operation\n returns information about associations with resource shares that use any version of the\n managed permission.
" } }, "associationStatus": { "target": "com.amazonaws.ram#ResourceShareAssociationStatus", "traits": { "smithy.api#documentation": "Specifies that you want to list only those associations with resource shares that match this\n status.
" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to list only those associations with resource shares that include at\n least one resource of this resource type.
" } }, "featureSet": { "target": "com.amazonaws.ram#PermissionFeatureSet", "traits": { "smithy.api#documentation": "Specifies that you want to list only those associations with resource shares that have a\n featureSet with this value.
When true, specifies that you want to list only those associations with\n resource shares that use the default version of the specified managed permission.
When false (the default value), lists associations with resource shares that use\n any version of the specified managed permission.
Specifies that you want to list only those associations with resource shares owned by a specific\n entity:
\n\n SELF \u2013 returns only associations with resource shares owned by the\n calling account.
\n OTHER-ACCOUNTS \u2013 returns only associations with resource shares\n owned by other Amazon Web Services accounts.
If you don't specify this parameter, the default is SELF.
Specifies the Amazon Resource Name (ARN) of the resource share for which you want to retrieve permission\n associations.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
A structure with information about this customer managed permission.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists the available versions of the specified RAM permission.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies the Amazon Resource Name (ARN) of the RAM permission whose versions you want to list. You\n can use the permissionVersion parameter on the AssociateResourceSharePermission operation to specify a non-default\n version to attach.
Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
An array of objects that contain details for each of the available versions.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Retrieves a list of available RAM permissions that you can use for the supported\n resource types.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies that you want to list only those permissions that apply to the specified\n resource type. This parameter is not case sensitive.
\nFor example, to list only permissions that apply to Amazon EC2 subnets, specify\n ec2:subnet. You can use the ListResourceTypes\n operation to get the specific string required.
Specifies that you want to list only permissions owned by a specific entity:
\n\n SELF \u2013 returns only permissions owned by the calling\n account.
\n OTHER-ACCOUNTS \u2013 returns only permissions shared with the\n calling account by other accounts.
Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
Specifies that you want to list only permissions of this type:
\n\n AWS \u2013 returns only Amazon Web Services managed permissions.
\n LOCAL \u2013 returns only customer managed permissions
\n ALL \u2013 returns both Amazon Web Services managed permissions and customer managed permissions.
If you don't specify this parameter, the default is All.
Specifies that you want to filter the results to include only permissions with the\n specified status. For example, use ATTACHABLE to list only permissions that\n can be associated with resource shares, or DEPRECATED to list only\n deprecated permissions.
An array of objects with information about the permissions.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists the principals that you are sharing resources with or that are sharing resources\n with you.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies that you want to list information for only resource shares that match the\n following:
\n\n \n SELF\n \u2013 principals that\n your account is sharing resources with
\n \n OTHER-ACCOUNTS\n \u2013\n principals that are sharing resources with your account
Specifies that you want to list principal information for the resource share with the specified\n Amazon Resource Name (ARN).
" } }, "principals": { "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { "smithy.api#documentation": "Specifies that you want to list information for only the listed principals.
\nYou can include the following values:
\nAn Amazon Web Services account ID, for example: 123456789012\n
An Amazon Resource Name (ARN) of an organization in Organizations, for example:\n organizations::123456789012:organization/o-exampleorgid\n
An ARN of an organizational unit (OU) in Organizations, for example:\n organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123\n
An ARN of an IAM role, for example:\n iam::123456789012:role/rolename\n
An ARN of an IAM user, for example:\n iam::123456789012user/username\n
A service principal name, for example: service-id.amazonaws.com\n
Not all resource types can be shared with IAM roles and users. \n For more information, see Sharing with IAM roles and users in the Resource Access Manager User\n Guide.
\nSpecifies that you want to list information for only principals associated with resource shares\n that include the specified resource type.
\nFor a list of valid values, query the ListResourceTypes\n operation.
" } }, "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { "smithy.api#documentation": "Specifies that you want to list information for only principals associated with the\n resource shares specified by a list the Amazon Resource Names (ARNs).
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
An array of objects that contain the details about the principals.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Retrieves the current status of the asynchronous tasks performed by RAM when you\n perform the ReplacePermissionAssociationsWork operation.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
A list of IDs. These values come from the idfield of the\n replacePermissionAssociationsWorkstructure returned by the ReplacePermissionAssociations operation.
Specifies that you want to see only the details about requests with a status that\n matches this value.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
An array of data structures that provide details of the matching work IDs.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists the RAM permissions that are associated with a resource share.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies the Amazon Resource Name (ARN) of the resource share for which you want to retrieve the associated\n permissions.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
An array of objects that describe the permissions associated with the resource share.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists the resource types that can be shared by RAM.
", "smithy.api#http": { "method": "POST", "uri": "/listresourcetypes", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.ram#ListResourceTypesRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
Specifies that you want the results to include only \n resources that have the specified scope.
\n\n ALL \u2013 the results include both global and \n regional resources or resource types.
\n GLOBAL \u2013 the results include only global \n resources or resource types.
\n REGIONAL \u2013 the results include only regional \n resources or resource types.
The default value is ALL.
An array of objects that contain information about the resource types that can be\n shared using RAM.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists the resources that you added to a resource share or the resources that are shared with\n you.
\nAlways check the NextToken response parameter for a null value\nwhen calling a paginated operation. These operations can occasionally return an empty set of results even when there are more\nresults available. The NextToken response parameter value is null\n only\nwhen there are no more results to display.
Specifies that you want to list only the resource shares that match the following:
\n\n \n SELF\n \u2013 resources that\n your account shares with other accounts
\n \n OTHER-ACCOUNTS\n \u2013\n resources that other accounts share with your account
Specifies that you want to list only the resource shares that are associated with the specified\n principal.
" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to list only the resource shares that include resources of the specified\n resource type.
\nFor valid values, query the ListResourceTypes operation.
" } }, "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { "smithy.api#documentation": "Specifies that you want to list only the resource shares that include resources with the\n specified Amazon Resource Names (ARNs).
" } }, "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { "smithy.api#documentation": "Specifies that you want to list only resources in the resource shares identified by the\n specified Amazon Resource Names (ARNs).
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
Specifies that you want the results to include only \n resources that have the specified scope.
\n\n ALL \u2013 the results include both global and \n regional resources or resource types.
\n GLOBAL \u2013 the results include only global \n resources or resource types.
\n REGIONAL \u2013 the results include only regional \n resources or resource types.
The default value is ALL.
An array of objects that contain information about the resources.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists source associations for resource shares. Source associations control which sources can be used with service principals in resource shares. This operation provides visibility into source associations for resource share owners.
\nYou can filter the results by resource share Amazon Resource Name (ARN), source ID, source type, or association status. We recommend using pagination to ensure that the operation returns quickly and successfully.
", "smithy.api#http": { "method": "POST", "uri": "/listsourceassociations", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "sourceAssociations", "pageSize": "maxResults" } } }, "com.amazonaws.ram#ListSourceAssociationsRequest": { "type": "structure", "members": { "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the resource shares for which you want to retrieve source associations.
" } }, "sourceId": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The identifier of the source for which you want to retrieve associations. This can be an account ID, Amazon Resource Name (ARN), organization ID, or organization path.
" } }, "sourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The type of source for which you want to retrieve associations.
" } }, "associationStatus": { "target": "com.amazonaws.ram#ResourceShareAssociationStatus", "traits": { "smithy.api#documentation": "The status of the source associations that you want to retrieve.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Information about the source associations.
" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The pagination token to use to retrieve the next page of results. This value is null when there are no more results to return.
The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't\n valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#MalformedPolicyTemplateException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "MalformedPolicyTemplateException", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the policy template that you provided isn't valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.ram#MissingRequiredParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "MissingRequiredParameter", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because a required input parameter is missing.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#OperationNotPermittedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "OperationNotPermitted", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the requested operation isn't permitted.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#PermissionAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "PermissionAlreadyExistsException", "httpResponseCode": 409 }, "smithy.api#documentation": "The operation failed because a permission with the specified name already exists in\n the requested Amazon Web Services Region. Choose a different name.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.ram#PermissionArnAndTemplateParameters": { "type": "structure", "members": { "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the permission to associate with the resource share.
" } }, "permissionTemplateParameters": { "target": "com.amazonaws.ram#PermissionTemplateParameterInputList", "traits": { "smithy.api#documentation": "The list of template parameter values to assign for this permission. You must provide\n values for all parameters declared in the permission template.
" } } }, "traits": { "smithy.api#documentation": "Contains a permission ARN and its associated template parameter values. The CreateResourceShare operation uses this structure when associating permissions that have template parameters.
" } }, "com.amazonaws.ram#PermissionArnAndTemplateParametersList": { "type": "list", "member": { "target": "com.amazonaws.ram#PermissionArnAndTemplateParameters", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#PermissionArnList": { "type": "list", "member": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#PermissionFeatureSet": { "type": "enum", "members": { "CREATED_FROM_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED_FROM_POLICY" } }, "PROMOTING_TO_STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROMOTING_TO_STANDARD" } }, "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } } } }, "com.amazonaws.ram#PermissionLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "PermissionLimitExceededException", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because it would exceed the maximum number of permissions you can\n create in each Amazon Web Services Region. To view the limits for your Amazon Web Services account, see the RAM page in the\n Service Quotas console.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#PermissionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 36 }, "smithy.api#pattern": "^[\\w.-]*$" } }, "com.amazonaws.ram#PermissionStatus": { "type": "enum", "members": { "ATTACHABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ATTACHABLE" } }, "UNATTACHABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNATTACHABLE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATED" } } } }, "com.amazonaws.ram#PermissionTemplateParameter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The name of the template parameter.
" } }, "type": { "target": "com.amazonaws.ram#PermissionTemplateParameterType", "traits": { "smithy.api#documentation": "The type of the template parameter. This can be one of the following values:
\n\n STRING \u2013 A single string value.
\n STRING_LIST \u2013 One or more string values.
A description of the template parameter.
" } }, "values": { "target": "com.amazonaws.ram#PermissionTemplateParameterValueList", "traits": { "smithy.api#documentation": "The values assigned to this template parameter in the context of a permission\n association. This field is present only when the parameter has been assigned values\n (for example, in the response from ListPermissionAssociations or\n ListResourceSharePermissions).
" } } }, "traits": { "smithy.api#documentation": "Contains the declaration of a template parameter for a customer managed permission. When returned in the context of a permission association, it also includes the values assigned to that parameter.
" } }, "com.amazonaws.ram#PermissionTemplateParameterDeclaration": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The name of the template parameter. This name is used as the placeholder in the\n policy template using the syntax @{parameterName}.
The type of the template parameter. This can be one of the following values:
\n\n STRING \u2013 A single string value that is substituted\n directly into the template.
\n STRING_LIST \u2013 One or more string values that expand to\n an array in the rendered policy.
A description of the template parameter that helps consumers understand what value to\n provide.
" } } }, "traits": { "smithy.api#documentation": "Describes a template parameter declaration for a customer managed permission. Each declaration defines a\n named placeholder that can be used in the permission's policy template.
" } }, "com.amazonaws.ram#PermissionTemplateParameterDeclarationList": { "type": "list", "member": { "target": "com.amazonaws.ram#PermissionTemplateParameterDeclaration", "traits": { "smithy.api#xmlName": "item" } }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.ram#PermissionTemplateParameterInput": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The name of the template parameter to assign a value to. This must match a parameter\n name declared in the permission template.
" } }, "values": { "target": "com.amazonaws.ram#PermissionTemplateParameterValueList", "traits": { "smithy.api#documentation": "The values to assign to the template parameter. For STRING type\n parameters, provide a single value. For STRING_LIST type parameters,\n provide one or more values.
Contains the name and values to assign to a template parameter when associating a permission template with a resource share.
" } }, "com.amazonaws.ram#PermissionTemplateParameterInputList": { "type": "list", "member": { "target": "com.amazonaws.ram#PermissionTemplateParameterInput", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#PermissionTemplateParameterList": { "type": "list", "member": { "target": "com.amazonaws.ram#PermissionTemplateParameter", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#PermissionTemplateParameterType": { "type": "enum", "members": { "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRING" } }, "STRING_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRING_LIST" } } } }, "com.amazonaws.ram#PermissionTemplateParameterValueList": { "type": "list", "member": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#PermissionType": { "type": "enum", "members": { "CUSTOMER_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_MANAGED" } }, "AWS_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_MANAGED" } } } }, "com.amazonaws.ram#PermissionTypeFilter": { "type": "enum", "members": { "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } }, "AWS_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_MANAGED" } }, "CUSTOMER_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_MANAGED" } } } }, "com.amazonaws.ram#PermissionVersionsLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "PermissionVersionsLimitExceededException", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because it would exceed the limit for the number of versions you\n can have for a permission. To view the limits for your Amazon Web Services account, see the RAM page in the\n Service Quotas console.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#Policy": { "type": "string" }, "com.amazonaws.ram#PolicyList": { "type": "list", "member": { "target": "com.amazonaws.ram#Policy", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#Principal": { "type": "structure", "members": { "id": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The ID of the principal that can be associated with a resource share.
" } }, "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a resource share the principal is associated with.
" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the principal was associated with the resource share.
" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the association between the resource share and the principal\n was last updated.
" } }, "external": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Indicates the relationship between the Amazon Web Services account the principal belongs to and the\n account that owns the resource share:
\n\n True \u2013 The two accounts belong to same\n organization.
\n False \u2013 The two accounts do not belong to the same\n organization.
Describes a principal for use with Resource Access Manager.
" } }, "com.amazonaws.ram#PrincipalArnOrIdList": { "type": "list", "member": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#PrincipalList": { "type": "list", "member": { "target": "com.amazonaws.ram#Principal", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#PromotePermissionCreatedFromPolicy": { "type": "operation", "input": { "target": "com.amazonaws.ram#PromotePermissionCreatedFromPolicyRequest" }, "output": { "target": "com.amazonaws.ram#PromotePermissionCreatedFromPolicyResponse" }, "errors": [ { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#InvalidPolicyException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#MissingRequiredParameterException" }, { "target": "com.amazonaws.ram#OperationNotPermittedException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "When you attach a resource-based policy to a resource, RAM automatically creates\n a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that\n has the same IAM permissions as the original resource-based policy. However, this type\n of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by\n using RAM.
This operation creates a separate, fully manageable customer managed permission that has the same IAM\n permissions as the original resource-based policy. You can associate this customer managed permission to any\n resource shares.
\nBefore you use PromoteResourceShareCreatedFromPolicy, you should\n first run this operation to ensure that you have an appropriate customer managed permission that can be\n associated with the promoted resource share.
\nThe original CREATED_FROM_POLICY policy isn't deleted, and\n resource shares using that original policy aren't automatically\n updated.
You can't modify a CREATED_FROM_POLICY resource share so you can't\n associate the new customer managed permission by using\n ReplacePermsissionAssociations. However, if you use PromoteResourceShareCreatedFromPolicy, that operation\n automatically associates the fully manageable customer managed permission to the newly promoted\n STANDARD resource share.
After you promote a resource share, if the original CREATED_FROM_POLICY\n managed permission has no other associations to A resource share, then RAM automatically deletes\n it.
Specifies the Amazon Resource Name (ARN) of the CREATED_FROM_POLICY permission that you\n want to promote. You can get this Amazon Resource Name (ARN) by calling the ListResourceSharePermissions operation.
Specifies a name for the promoted customer managed permission.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
The details of the promoted customer managed permission, including its Amazon Resource Name (ARN), version, and status.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
When you attach a resource-based policy to a resource, RAM automatically creates\n a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that\n has the same IAM permissions as the original resource-based policy. However, this type\n of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by\n using RAM.
This operation promotes the resource share to a STANDARD resource share that is fully\n manageable in RAM. When you promote a resource share, you can then manage the resource share in RAM and\n 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\n appropriate customer managed permission that can be associated with this resource share after its is promoted. If\n this operation can't find a managed permission that exactly matches the existing\n CREATED_FROM_POLICY permission, then this operation fails.
Specifies the Amazon Resource Name (ARN) of the resource share to promote.
", "smithy.api#httpQuery": "resourceShareArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ram#PromoteResourceShareCreatedFromPolicyResponse": { "type": "structure", "members": { "returnValue": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.
Rejects an invitation to a resource share from another Amazon Web Services account.
", "smithy.api#http": { "method": "POST", "uri": "/rejectresourceshareinvitation", "code": 200 } } }, "com.amazonaws.ram#RejectResourceShareInvitationRequest": { "type": "structure", "members": { "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the invitation that you want to reject.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
An object that contains the details about the rejected invitation.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
Updates all resource shares that use a managed permission to a different managed\n permission. This operation always applies the default version of the target managed\n permission. You can optionally specify that the update applies to only resource shares that\n currently use a specified version. This enables you to update to the latest version,\n without changing the which managed permission is used.
\nYou can use this operation to update all of your resource shares to use the current\n default version of the permission by specifying the same value for the\n fromPermissionArn and toPermissionArn parameters.
You can use the optional fromPermissionVersion parameter to update only\n those resources that use a specified version of the managed permission to the new managed\n permission.
To successfully perform this operation, you must have permission to update the\n resource-based policy on all affected resource types.
\nSpecifies the Amazon Resource Name (ARN) of the managed permission that you want to replace.
", "smithy.api#required": {} } }, "fromPermissionVersion": { "target": "com.amazonaws.ram#Integer", "traits": { "smithy.api#documentation": "Specifies that you want to updated the permissions for only those resource shares that use the\n specified version of the managed permission.
" } }, "toPermissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the ARN of the managed permission that you want to associate with resource\n shares in place of the one specified by fromPerssionArn and\n fromPermissionVersion.
The operation always associates the version that is currently the default for the\n specified managed permission.
", "smithy.api#required": {} } }, "permissionTemplateParameters": { "target": "com.amazonaws.ram#PermissionTemplateParameterInputList", "traits": { "smithy.api#documentation": "Specifies the template parameter values to apply when replacing the permission. You\n must provide values for all parameters declared in the target permission template. This\n parameter is required only if the target permission (toPermissionArn) has\n template parameters.
Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies a data structure that you can use to track the asynchronous tasks that RAM\n performs to complete this operation. You can use the ListReplacePermissionAssociationsWork operation and pass the\n id value returned in this structure.
The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
The unique identifier for the background task associated with one ReplacePermissionAssociations request.
" } }, "fromPermissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the managed permission that this background task is replacing.
" } }, "fromPermissionVersion": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The version of the managed permission that this background task is replacing.
" } }, "toPermissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The ARN of the managed permission that this background task is associating with the resource shares in place\n of the managed permission and version specified in fromPermissionArn and\n fromPermissionVersion.
The version of the managed permission that this background task is associating with the resource shares. This\n is always the version that is currently the default for this managed permission.
" } }, "permissionTemplateParameters": { "target": "com.amazonaws.ram#PermissionTemplateParameterList", "traits": { "smithy.api#documentation": "The template parameter values to apply when replacing the permission. This field is\n present only if the target permission is a template with declared parameters.
" } }, "status": { "target": "com.amazonaws.ram#ReplacePermissionAssociationsWorkStatus", "traits": { "smithy.api#documentation": "Specifies the current status of the background tasks for the specified ID. The output\n is one of the following strings:
\n\n IN_PROGRESS\n
\n COMPLETED\n
\n FAILED\n
Specifies the reason for a FAILED status. This field is present only when\n there status is FAILED.
The date and time when this asynchronous background task was created.
" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the status of this background task was last updated.
" } } }, "traits": { "smithy.api#documentation": "A structure that represents the background work that RAM performs when you invoke\n the ReplacePermissionAssociations operation.
" } }, "com.amazonaws.ram#ReplacePermissionAssociationsWorkIdList": { "type": "list", "member": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ReplacePermissionAssociationsWorkList": { "type": "list", "member": { "target": "com.amazonaws.ram#ReplacePermissionAssociationsWork", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ReplacePermissionAssociationsWorkStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.ram#Resource": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, "type": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The resource type. This takes the form of:\n service-code:resource-code, and is case-insensitive. For\n example, an Amazon EC2 Subnet would be represented by the string\n ec2:subnet.
The Amazon Resource Name (ARN) of the resource share this resource is associated with.
" } }, "resourceGroupArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource group. This value is available only if the resource is\n part of a resource group.
" } }, "status": { "target": "com.amazonaws.ram#ResourceStatus", "traits": { "smithy.api#documentation": "The current status of the resource.
" } }, "statusMessage": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "A message about the status of the resource.
" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the resource was associated with the resource share.
" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date an time when the association between the resource and the resource share was\n last updated.
" } }, "resourceRegionScope": { "target": "com.amazonaws.ram#ResourceRegionScope", "traits": { "smithy.api#documentation": "Specifies the scope of visibility of this resource:
\n\n REGIONAL \u2013 The resource can be\n accessed only by using requests that target the Amazon Web Services Region in which the\n resource exists.
\n\n GLOBAL \u2013 The resource can be accessed\n from any Amazon Web Services Region.
\nDescribes a resource associated with a resource share in RAM.
" } }, "com.amazonaws.ram#ResourceArnList": { "type": "list", "member": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ResourceArnNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidResourceArn.NotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified Amazon Resource Name (ARN) was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#ResourceList": { "type": "list", "member": { "target": "com.amazonaws.ram#Resource", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ResourceOwner": { "type": "enum", "members": { "SELF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELF" } }, "OTHER_ACCOUNTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER-ACCOUNTS" } } } }, "com.amazonaws.ram#ResourceRegionScope": { "type": "enum", "members": { "REGIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REGIONAL" } }, "GLOBAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GLOBAL" } } } }, "com.amazonaws.ram#ResourceRegionScopeFilter": { "type": "enum", "members": { "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } }, "REGIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REGIONAL" } }, "GLOBAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GLOBAL" } } } }, "com.amazonaws.ram#ResourceShare": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource share
" } }, "name": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The name of the resource share.
" } }, "owningAccountId": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the resource share.
" } }, "allowExternalPrincipals": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Indicates whether principals outside your organization in Organizations can be associated\n with a resource share.
\n\n True \u2013 the resource share can be shared with any\n Amazon Web Services account.
\n False \u2013 the resource share can be shared with only\n accounts in the same organization as the account that owns the resource\n share.
The current status of the resource share.
" } }, "statusMessage": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "A message about the status of the resource share.
" } }, "tags": { "target": "com.amazonaws.ram#TagList", "traits": { "smithy.api#documentation": "The tag key and value pairs attached to the resource share.
" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the resource share was created.
" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the resource share was last updated.
" } }, "featureSet": { "target": "com.amazonaws.ram#ResourceShareFeatureSet", "traits": { "smithy.api#documentation": "Indicates what features are available for this resource share. This parameter can have one of\n the following values:
\n\n STANDARD \u2013 A resource share that supports all\n functionality. These resource shares are visible to all principals you share the resource share with. \n You can modify these resource shares in RAM using the console or APIs. This resource share might \n have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
\n\n CREATED_FROM_POLICY \u2013 The customer\n manually shared a resource by attaching a resource-based policy. That policy did\n not match any existing managed permissions, so RAM created this customer managed permission automatically on the\n customer's behalf based on the attached policy document. This type of resource share \n is visible only to the Amazon Web Services account that created it. You can't modify it in \n RAM unless you promote it. For more information, \n see PromoteResourceShareCreatedFromPolicy.
\n\n PROMOTING_TO_STANDARD \u2013 This\n resource share was originally CREATED_FROM_POLICY, but the customer ran\n the PromoteResourceShareCreatedFromPolicy and that operation\n is still in progress. This value changes to STANDARD when\n complete.
The configuration of the resource share
" } } }, "traits": { "smithy.api#documentation": "Describes a resource share in RAM.
" } }, "com.amazonaws.ram#ResourceShareArnList": { "type": "list", "member": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ResourceShareAssociation": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource share.
" } }, "resourceShareName": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The name of the resource share.
" } }, "associatedEntity": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The associated entity. This can be either of the following:
\nFor a resource association, this is the Amazon Resource Name (ARN) of the resource.
\nFor principal associations, this is one of the following:
\nThe ID of an Amazon Web Services account
\nThe Amazon Resource Name (ARN) of an organization in Organizations
\nThe ARN of an organizational unit (OU) in Organizations
\nThe ARN of an IAM role
\nThe ARN of an IAM user
\nThe type of entity included in this association.
" } }, "status": { "target": "com.amazonaws.ram#ResourceShareAssociationStatus", "traits": { "smithy.api#documentation": "The current status of the association.
" } }, "statusMessage": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "A message about the status of the association.
" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the association was created.
" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the association was last updated.
" } }, "external": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Indicates whether the principal belongs to the same organization in Organizations as the\n Amazon Web Services account that owns the resource share.
" } } }, "traits": { "smithy.api#documentation": "Describes an association between a resource share and either a principal or a resource.
" } }, "com.amazonaws.ram#ResourceShareAssociationList": { "type": "list", "member": { "target": "com.amazonaws.ram#ResourceShareAssociation", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ResourceShareAssociationStatus": { "type": "enum", "members": { "ASSOCIATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATING" } }, "ASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "DISASSOCIATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISASSOCIATING" } }, "DISASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISASSOCIATED" } }, "SUSPENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUSPENDED" } }, "SUSPENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUSPENDING" } }, "RESTORING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTORING" } } } }, "com.amazonaws.ram#ResourceShareAssociationType": { "type": "enum", "members": { "PRINCIPAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRINCIPAL" } }, "RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE" } }, "SOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE" } } } }, "com.amazonaws.ram#ResourceShareConfiguration": { "type": "structure", "members": { "retainSharingOnAccountLeaveOrganization": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the consumer account retains access to the resource share after leaving the organization.
" } } }, "traits": { "smithy.api#documentation": "The configuration of the resource share
" } }, "com.amazonaws.ram#ResourceShareFeatureSet": { "type": "enum", "members": { "CREATED_FROM_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED_FROM_POLICY" } }, "PROMOTING_TO_STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROMOTING_TO_STANDARD" } }, "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } } } }, "com.amazonaws.ram#ResourceShareInvitation": { "type": "structure", "members": { "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the invitation.
" } }, "resourceShareName": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The name of the resource share.
" } }, "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource share
" } }, "senderAccountId": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The ID of the Amazon Web Services account that sent the invitation.
" } }, "receiverAccountId": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The ID of the Amazon Web Services account that received the invitation.
" } }, "invitationTimestamp": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the invitation was sent.
" } }, "status": { "target": "com.amazonaws.ram#ResourceShareInvitationStatus", "traits": { "smithy.api#documentation": "The current status of the invitation.
" } }, "resourceShareAssociations": { "target": "com.amazonaws.ram#ResourceShareAssociationList", "traits": { "smithy.api#deprecated": { "message": "This member has been deprecated. Use ListPendingInvitationResources." }, "smithy.api#documentation": "To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.
" } }, "receiverArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM user or role that received the invitation.
" } } }, "traits": { "smithy.api#documentation": "Describes an invitation for an Amazon Web Services account to join a resource share.
" } }, "com.amazonaws.ram#ResourceShareInvitationAlreadyAcceptedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidResourceShareInvitationArn.AlreadyAccepted", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified invitation was already accepted.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#ResourceShareInvitationAlreadyRejectedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidResourceShareInvitationArn.AlreadyRejected", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified invitation was already rejected.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#ResourceShareInvitationArnList": { "type": "list", "member": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ResourceShareInvitationArnNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidResourceShareInvitationArn.NotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not\n found.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#ResourceShareInvitationExpiredException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidResourceShareInvitationArn.Expired", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified invitation is past its expiration date and\n time.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#ResourceShareInvitationList": { "type": "list", "member": { "target": "com.amazonaws.ram#ResourceShareInvitation", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ResourceShareInvitationStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } } } }, "com.amazonaws.ram#ResourceShareLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceShareLimitExceeded", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because it would exceed the limit for resource shares for your account. You\n can associate up to 100 resources per call. To view the limits for your Amazon Web Services account,\n see the RAM page in\n the Service Quotas console.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#ResourceShareList": { "type": "list", "member": { "target": "com.amazonaws.ram#ResourceShare", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ResourceSharePermissionDetail": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of this RAM managed permission.
" } }, "version": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The version of the permission described in this response.
" } }, "defaultVersion": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the version of the permission represented in this response is the\n default version for this permission.
" } }, "name": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The name of this permission.
" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The resource type to which this permission applies.
" } }, "permission": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The permission's effect and actions in JSON format. The effect indicates\n whether the specified actions are allowed or denied. The actions list the\n operations to which the principal is granted or denied access.
The list of template parameter declarations defined for this permission. Each\n declaration includes the parameter name, type, and description. This field is present\n only if the permission is a template with declared parameters.
" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the permission was created.
" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the permission was last updated.
" } }, "isResourceTypeDefault": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the version of the permission represented in this response is the\n default version for all resources of this resource type.
" } }, "permissionType": { "target": "com.amazonaws.ram#PermissionType", "traits": { "smithy.api#documentation": "The type of managed permission. This can be one of the following values:
\n\n AWS_MANAGED \u2013 Amazon Web Services created and manages this\n managed permission. You can associate it with your resource shares, but you can't modify it.
\n CUSTOMER_MANAGED \u2013 You, or another principal in\n your account created this managed permission. You can associate it with your resource shares and create\n new versions that have different permissions.
Indicates what features are available for this resource share. This parameter can have one of\n the following values:
\n\n STANDARD \u2013 A resource share that supports all\n functionality. These resource shares are visible to all principals you share the resource share with. \n You can modify these resource shares in RAM using the console or APIs. This resource share might \n have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
\n\n CREATED_FROM_POLICY \u2013 The customer\n manually shared a resource by attaching a resource-based policy. That policy did\n not match any existing managed permissions, so RAM created this customer managed permission automatically on the\n customer's behalf based on the attached policy document. This type of resource share \n is visible only to the Amazon Web Services account that created it. You can't modify it in \n RAM unless you promote it. For more information, \n see PromoteResourceShareCreatedFromPolicy.
\n\n PROMOTING_TO_STANDARD \u2013 This\n resource share was originally CREATED_FROM_POLICY, but the customer ran\n the PromoteResourceShareCreatedFromPolicy and that operation\n is still in progress. This value changes to STANDARD when\n complete.
The current status of the association between the permission and the resource share.\n The following are the possible values:
\n\n ATTACHABLE \u2013 This permission or version can be associated \n with resource shares.
\n UNATTACHABLE \u2013 This permission or version can't \n currently be associated with resource shares.
\n DELETING \u2013 This permission or version is in the process of\n being deleted.
\n DELETED \u2013 This permission or version is deleted.
\n DEPRECATED \u2013 The permission owner deprecated this permission. It can't be associated with new resource shares, but existing\n associations continue to function.
The tag key and value pairs attached to the resource share.
" } }, "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { "smithy.api#documentation": "The owner of the permission. This can be one of the following values:
\n\n SELF \u2013 The permission is owned by the current\n account.
\n OTHER-ACCOUNTS \u2013 The permission is owned by another\n account and shared with the current account.
Information about a RAM managed permission.
" } }, "com.amazonaws.ram#ResourceSharePermissionList": { "type": "list", "member": { "target": "com.amazonaws.ram#ResourceSharePermissionSummary", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ResourceSharePermissionSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the permission you want information about.
" } }, "version": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The version of the permission associated with this resource share.
" } }, "defaultVersion": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the version of the managed permission used by this resource share is the default version for\n this managed permission.
" } }, "name": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The name of this managed permission.
" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The type of resource to which this permission applies. This takes the form of:\n service-code:resource-code, and is case-insensitive. For\n example, an Amazon EC2 Subnet would be represented by the string\n ec2:subnet.
The current status of the permission.
" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the permission was created.
" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { "smithy.api#documentation": "The date and time when the permission was last updated.
" } }, "isResourceTypeDefault": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the managed permission associated with this resource share is the default managed permission for all\n resources of this resource type.
" } }, "permissionType": { "target": "com.amazonaws.ram#PermissionType", "traits": { "smithy.api#documentation": "The type of managed permission. This can be one of the following values:
\n\n AWS_MANAGED \u2013 Amazon Web Services created and manages this\n managed permission. You can associate it with your resource shares, but you can't modify it.
\n CUSTOMER_MANAGED \u2013 You, or another principal in\n your account created this managed permission. You can associate it with your resource shares and create\n new versions that have different permissions.
Indicates what features are available for this resource share. This parameter can have one of\n the following values:
\n\n STANDARD \u2013 A resource share that supports all\n functionality. These resource shares are visible to all principals you share the resource share with. \n You can modify these resource shares in RAM using the console or APIs. This resource share might \n have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
\n\n CREATED_FROM_POLICY \u2013 The customer\n manually shared a resource by attaching a resource-based policy. That policy did\n not match any existing managed permissions, so RAM created this customer managed permission automatically on the\n customer's behalf based on the attached policy document. This type of resource share \n is visible only to the Amazon Web Services account that created it. You can't modify it in \n RAM unless you promote it. For more information, \n see PromoteResourceShareCreatedFromPolicy.
\n\n PROMOTING_TO_STANDARD \u2013 This\n resource share was originally CREATED_FROM_POLICY, but the customer ran\n the PromoteResourceShareCreatedFromPolicy and that operation\n is still in progress. This value changes to STANDARD when\n complete.
The list of template parameters defined for this permission, including their names,\n types, descriptions, and values. This field is present only if the permission is a\n template with declared parameters. When returned in the context of a permission\n association, the values are also included.
" } }, "tags": { "target": "com.amazonaws.ram#TagList", "traits": { "smithy.api#documentation": "A list of the tag key value pairs currently attached to the permission.
" } }, "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { "smithy.api#documentation": "The owner of the permission. This can be one of the following values:
\n\n SELF \u2013 The permission is owned by the current\n account.
\n OTHER-ACCOUNTS \u2013 The permission is owned by another\n account and shared with the current account.
Information about an RAM permission.
" } }, "com.amazonaws.ram#ResourceShareStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.ram#ResourceStatus": { "type": "enum", "members": { "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "ZONAL_RESOURCE_INACCESSIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZONAL_RESOURCE_INACCESSIBLE" } }, "LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LIMIT_EXCEEDED" } }, "UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNAVAILABLE" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } } } }, "com.amazonaws.ram#ServerInternalException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InternalError", "httpResponseCode": 500 }, "smithy.api#documentation": "The operation failed because the service could not respond to the request due to an\n internal problem. Try again later.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.ram#ServiceNameAndResourceType": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The type of the resource. This takes the form of:\n service-code:resource-code, and is case-insensitive. For\n example, an Amazon EC2 Subnet would be represented by the string\n ec2:subnet.
The name of the Amazon Web Services service to which resources of this type belong.
" } }, "resourceRegionScope": { "target": "com.amazonaws.ram#ResourceRegionScope", "traits": { "smithy.api#documentation": "Specifies the scope of visibility of resources of this type:
\n\n REGIONAL \u2013 The resource can be\n accessed only by using requests that target the Amazon Web Services Region in which the\n resource exists.
\n\n GLOBAL \u2013 The resource can be accessed\n from any Amazon Web Services Region.
\nInformation about a shareable resource type and the Amazon Web Services service to which resources\n of that type belong.
" } }, "com.amazonaws.ram#ServiceNameAndResourceTypeList": { "type": "list", "member": { "target": "com.amazonaws.ram#ServiceNameAndResourceType", "traits": { "smithy.api#xmlName": "item" } } }, "com.amazonaws.ram#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "Unavailable", "httpResponseCode": 503 }, "smithy.api#documentation": "The operation failed because the service isn't available. Try again later.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.ram#SetDefaultPermissionVersion": { "type": "operation", "input": { "target": "com.amazonaws.ram#SetDefaultPermissionVersionRequest" }, "output": { "target": "com.amazonaws.ram#SetDefaultPermissionVersionResponse" }, "errors": [ { "target": "com.amazonaws.ram#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.ram#InvalidClientTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "Designates the specified version number as the default version for the specified\n customer managed permission. New resource shares automatically use this new default permission. Existing\n resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.
", "smithy.api#http": { "method": "POST", "uri": "/setdefaultpermissionversion", "code": 200 } } }, "com.amazonaws.ram#SetDefaultPermissionVersionRequest": { "type": "structure", "members": { "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the customer managed permission whose default version you want to change.
", "smithy.api#required": {} } }, "permissionVersion": { "target": "com.amazonaws.ram#Integer", "traits": { "smithy.api#documentation": "Specifies the version number that you want to designate as the default for customer managed permission. To\n see a list of all available version numbers, use ListPermissionVersions.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
A boolean value that indicates whether the operation was successful.
", "smithy.api#xmlName": "return" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
The key, or name, attached to the tag. Every tag must have a key. Key names are case\n sensitive.
" } }, "value": { "target": "com.amazonaws.ram#TagValue", "traits": { "smithy.api#documentation": "The string value attached to the tag. The value can be an empty string. Key values are\n case sensitive.
" } } }, "traits": { "smithy.api#documentation": "A structure containing a tag. A tag is metadata that you can attach to your resources\n to help organize and categorize them. You can also use them to help you secure your\n resources. For more information, see Controlling access to Amazon Web Services resources\n using tags.
\nFor more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference Guide.
" } }, "com.amazonaws.ram#TagFilter": { "type": "structure", "members": { "tagKey": { "target": "com.amazonaws.ram#TagKey", "traits": { "smithy.api#documentation": "The tag key. This must have a valid string value and can't be empty.
" } }, "tagValues": { "target": "com.amazonaws.ram#TagValueList", "traits": { "smithy.api#documentation": "A list of zero or more tag values. If no values are provided, then the filter matches\n any tag with the specified key, regardless of its value.
" } } }, "traits": { "smithy.api#documentation": "A tag key and optional list of possible values that you can use to filter results for\n tagged resources.
\nMultiple tag filters are evaluated as an OR condition.
\nThe operation failed because it would exceed the limit for tags for your\n Amazon Web Services account.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#TagList": { "type": "list", "member": { "target": "com.amazonaws.ram#Tag" } }, "com.amazonaws.ram#TagPolicyViolationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "TagPolicyViolation", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because the specified tag key is a reserved word and can't be\n used.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.ram#TagResourceRequest" }, "output": { "target": "com.amazonaws.ram#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#ResourceArnNotFoundException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#TagLimitExceededException" }, { "target": "com.amazonaws.ram#TagPolicyViolationException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the\n tags are attached to only the resource share, not to the resources that are in the resource share.
\nThe tags on a managed permission are the same for all versions of the managed permission.
", "smithy.api#http": { "method": "POST", "uri": "/tagresource", "code": 200 } } }, "com.amazonaws.ram#TagResourceRequest": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the resource share that you want to add tags to. You must specify\n either\n resourceShareArn, or resourceArn, but not both.
A list of one or more tag key and value pairs. The tag key must be present and not be\n an empty string. The tag value must be present but can be an empty string.
", "smithy.api#required": {} } }, "resourceArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the managed permission that you want to add tags to. You must specify\n either\n resourceArn, or resourceShareArn, but not both.
The operation failed because it exceeded the rate at which you are allowed to perform\n this operation. Please try again later.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.ram#UnknownResourceException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidResourceShareArn.NotFound", "httpResponseCode": 400 }, "smithy.api#documentation": "The operation failed because a specified resource couldn't be found.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#UnmatchedPolicyPermissionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#required": {} } } }, "traits": { "aws.protocols#awsQueryError": { "code": "UnmatchedPolicyPermissionException", "httpResponseCode": 400 }, "smithy.api#documentation": "There isn't an existing managed permission defined in RAM that has the same IAM permissions as\n the resource-based policy attached to the resource. You should first run PromotePermissionCreatedFromPolicy to create that managed permission.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ram#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.ram#UntagResourceRequest" }, "output": { "target": "com.amazonaws.ram#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "Removes the specified tag key and value pairs from the specified resource share or managed permission.
", "smithy.api#http": { "method": "POST", "uri": "/untagresource", "code": 200 } } }, "com.amazonaws.ram#UntagResourceRequest": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the resource share that you want to remove tags from. The tags are\n removed from the resource share, not the resources in the resource share. You must specify either\n resourceShareArn, or resourceArn, but not both.
Specifies a list of one or more tag keys that you want to remove.
", "smithy.api#required": {} } }, "resourceArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the managed permission that you want to remove tags from. You must\n specify either resourceArn, or resourceShareArn, but not\n both.
Updates the status of the specified customer managed permission.
\nSetting the status to DEPRECATED prevents new resource share associations. Setting it to ATTACHABLE restores a previously deprecated permission. Existing resource shares that use the permission continue to function.
Specifies the Amazon Resource Name (ARN) of the customer managed permission that you want to update.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.ram#UpdatePermissionStatus", "traits": { "smithy.api#documentation": "Specifies the new status for the permission. This can be one of the following\n values:
\n\n ATTACHABLE \u2013 Restores a previously deprecated permission\n so it can be associated with resource shares again.
\n DEPRECATED \u2013 Deprecates the permission so it can no\n longer be associated with new resource shares.
Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.
The updated status of the permission.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ram#UpdatePermissionStatus": { "type": "enum", "members": { "ATTACHABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ATTACHABLE" } }, "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATED" } } } }, "com.amazonaws.ram#UpdateResourceShare": { "type": "operation", "input": { "target": "com.amazonaws.ram#UpdateResourceShareRequest" }, "output": { "target": "com.amazonaws.ram#UpdateResourceShareResponse" }, "errors": [ { "target": "com.amazonaws.ram#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.ram#InvalidClientTokenException" }, { "target": "com.amazonaws.ram#InvalidParameterException" }, { "target": "com.amazonaws.ram#MalformedArnException" }, { "target": "com.amazonaws.ram#MissingRequiredParameterException" }, { "target": "com.amazonaws.ram#OperationNotPermittedException" }, { "target": "com.amazonaws.ram#ServerInternalException" }, { "target": "com.amazonaws.ram#ServiceUnavailableException" }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { "smithy.api#documentation": "Modifies some of the properties of the specified resource share.
", "smithy.api#http": { "method": "POST", "uri": "/updateresourceshare", "code": 200 } } }, "com.amazonaws.ram#UpdateResourceShareRequest": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the resource share that you want to modify.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "If specified, the new name that you want to attach to the resource share.
" } }, "allowExternalPrincipals": { "target": "com.amazonaws.ram#Boolean", "traits": { "smithy.api#documentation": "Specifies whether principals outside your organization in Organizations can be associated\n with a resource share.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Information about the resource share.
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { "smithy.api#documentation": "The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.