codegen-resources.docs-2.json Maven / Gradle / Ivy
Show all versions of ram Show documentation
{
"version": "2.0",
"service": "Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resource. The following principals are supported:
-
The ID of an AWS account
-
The Amazon Resource Name (ARN) of an OU from AWS Organizations
-
The Amazon Resource Name (ARN) of an organization from AWS Organizations
If you specify an AWS account that doesn't exist in the same organization as the account that owns the resource share, the owner of the specified account receives an invitation to accept the resource share. After the owner accepts the invitation, they can access the resources in the resource share. An administrator of the specified account can use IAM policies to restrict access resources in the resource share.
",
"operations": {
"AcceptResourceShareInvitation": "Accepts an invitation to a resource share from another AWS account.
",
"AssociateResourceShare": "Associates the specified resource share with the specified principals and resources.
",
"CreateResourceShare": "Creates a resource share.
",
"DeleteResourceShare": "Deletes the specified resource share.
",
"DisassociateResourceShare": "Disassociates the specified principals or resources from the specified resource share.
",
"EnableSharingWithAwsOrganization": "Enables resource sharing within your organization.
",
"GetResourcePolicies": "Gets the policies for the specifies resources.
",
"GetResourceShareAssociations": "Gets the associations for the specified resource share.
",
"GetResourceShareInvitations": "Gets the specified invitations for resource sharing.
",
"GetResourceShares": "Gets the specified resource shares or all of your resource shares.
",
"ListPrincipals": "Lists the principals with access to the specified resource.
",
"ListResources": "Lists the resources that the specified principal can access.
",
"RejectResourceShareInvitation": "Rejects an invitation to a resource share from another AWS account.
",
"TagResource": "Adds the specified tags to the specified resource share.
",
"UntagResource": "Removes the specified tags from the specified resource share.
",
"UpdateResourceShare": "Updates the specified resource share.
"
},
"shapes": {
"AcceptResourceShareInvitationRequest": {
"base": null,
"refs": {
}
},
"AcceptResourceShareInvitationResponse": {
"base": null,
"refs": {
}
},
"AssociateResourceShareRequest": {
"base": null,
"refs": {
}
},
"AssociateResourceShareResponse": {
"base": null,
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"CreateResourceShareRequest$allowExternalPrincipals": "Indicates whether principals outside your organization can be associated with a resource share.
",
"DeleteResourceShareResponse$returnValue": "Indicates whether the request succeeded.
",
"EnableSharingWithAwsOrganizationResponse$returnValue": "Indicates whether the request succeeded.
",
"Principal$external": "Indicates whether the principal belongs to the same organization as the AWS account that owns the resource share.
",
"ResourceShare$allowExternalPrincipals": "Indicates whether principals outside your organization can be associated with a resource share.
",
"ResourceShareAssociation$external": "Indicates whether the principal belongs to the same organization as the AWS account that owns the resource share.
",
"UpdateResourceShareRequest$allowExternalPrincipals": "Indicates whether principals outside your organization can be associated with a resource share.
"
}
},
"CreateResourceShareRequest": {
"base": null,
"refs": {
}
},
"CreateResourceShareResponse": {
"base": null,
"refs": {
}
},
"DateTime": {
"base": null,
"refs": {
"Principal$creationTime": "The time when the principal was associated with the resource share.
",
"Principal$lastUpdatedTime": "The time when the association was last updated.
",
"Resource$creationTime": "The time when the resource was associated with the resource share.
",
"Resource$lastUpdatedTime": "The time when the association was last updated.
",
"ResourceShare$creationTime": "The time when the resource share was created.
",
"ResourceShare$lastUpdatedTime": "The time when the resource share was last updated.
",
"ResourceShareAssociation$creationTime": "The time when the association was created.
",
"ResourceShareAssociation$lastUpdatedTime": "The time when the association was last updated.
",
"ResourceShareInvitation$invitationTimestamp": "The date and time when the invitation was sent.
"
}
},
"DeleteResourceShareRequest": {
"base": null,
"refs": {
}
},
"DeleteResourceShareResponse": {
"base": null,
"refs": {
}
},
"DisassociateResourceShareRequest": {
"base": null,
"refs": {
}
},
"DisassociateResourceShareResponse": {
"base": null,
"refs": {
}
},
"EnableSharingWithAwsOrganizationRequest": {
"base": null,
"refs": {
}
},
"EnableSharingWithAwsOrganizationResponse": {
"base": null,
"refs": {
}
},
"GetResourcePoliciesRequest": {
"base": null,
"refs": {
}
},
"GetResourcePoliciesResponse": {
"base": null,
"refs": {
}
},
"GetResourceShareAssociationsRequest": {
"base": null,
"refs": {
}
},
"GetResourceShareAssociationsResponse": {
"base": null,
"refs": {
}
},
"GetResourceShareInvitationsRequest": {
"base": null,
"refs": {
}
},
"GetResourceShareInvitationsResponse": {
"base": null,
"refs": {
}
},
"GetResourceSharesRequest": {
"base": null,
"refs": {
}
},
"GetResourceSharesResponse": {
"base": null,
"refs": {
}
},
"IdempotentParameterMismatchException": {
"base": "A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.
",
"refs": {
}
},
"InvalidClientTokenException": {
"base": "A client token is not valid.
",
"refs": {
}
},
"InvalidMaxResultsException": {
"base": "The specified value for MaxResults is not valid.
",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "The specified value for NextToken is not valid.
",
"refs": {
}
},
"InvalidParameterException": {
"base": "A parameter is not valid.
",
"refs": {
}
},
"InvalidResourceTypeException": {
"base": "The specified resource type is not valid.
",
"refs": {
}
},
"InvalidStateTransitionException": {
"base": "The requested state transition is not valid.
",
"refs": {
}
},
"ListPrincipalsRequest": {
"base": null,
"refs": {
}
},
"ListPrincipalsResponse": {
"base": null,
"refs": {
}
},
"ListResourcesRequest": {
"base": null,
"refs": {
}
},
"ListResourcesResponse": {
"base": null,
"refs": {
}
},
"MalformedArnException": {
"base": "The format of an Amazon Resource Name (ARN) is not valid.
",
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"GetResourcePoliciesRequest$maxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
",
"GetResourceShareAssociationsRequest$maxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
",
"GetResourceShareInvitationsRequest$maxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
",
"GetResourceSharesRequest$maxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
",
"ListPrincipalsRequest$maxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
",
"ListResourcesRequest$maxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
"
}
},
"MissingRequiredParameterException": {
"base": "A required input parameter is missing.
",
"refs": {
}
},
"OperationNotPermittedException": {
"base": "The requested operation is not permitted.
",
"refs": {
}
},
"Policy": {
"base": null,
"refs": {
"PolicyList$member": null
}
},
"PolicyList": {
"base": null,
"refs": {
"GetResourcePoliciesResponse$policies": "A key policy document, in JSON format.
"
}
},
"Principal": {
"base": "Describes a principal for use with AWS Resource Access Manager.
",
"refs": {
"PrincipalList$member": null
}
},
"PrincipalArnOrIdList": {
"base": null,
"refs": {
"AssociateResourceShareRequest$principals": "The principals.
",
"CreateResourceShareRequest$principals": "The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.
",
"DisassociateResourceShareRequest$principals": "The principals.
",
"ListPrincipalsRequest$principals": "The principals.
"
}
},
"PrincipalList": {
"base": null,
"refs": {
"ListPrincipalsResponse$principals": "The principals.
"
}
},
"RejectResourceShareInvitationRequest": {
"base": null,
"refs": {
}
},
"RejectResourceShareInvitationResponse": {
"base": null,
"refs": {
}
},
"Resource": {
"base": "Describes a resource associated with a resource share.
",
"refs": {
"ResourceList$member": null
}
},
"ResourceArnList": {
"base": null,
"refs": {
"AssociateResourceShareRequest$resourceArns": "The Amazon Resource Names (ARN) of the resources.
",
"CreateResourceShareRequest$resourceArns": "The Amazon Resource Names (ARN) of the resources to associate with the resource share.
",
"DisassociateResourceShareRequest$resourceArns": "The Amazon Resource Names (ARN) of the resources.
",
"GetResourcePoliciesRequest$resourceArns": "The Amazon Resource Names (ARN) of the resources.
",
"ListResourcesRequest$resourceArns": "The Amazon Resource Names (ARN) of the resources.
"
}
},
"ResourceArnNotFoundException": {
"base": "An Amazon Resource Name (ARN) was not found.
",
"refs": {
}
},
"ResourceList": {
"base": null,
"refs": {
"ListResourcesResponse$resources": "Information about the resources.
"
}
},
"ResourceOwner": {
"base": null,
"refs": {
"GetResourceSharesRequest$resourceOwner": "The type of owner.
",
"ListPrincipalsRequest$resourceOwner": "The type of owner.
",
"ListResourcesRequest$resourceOwner": "The type of owner.
"
}
},
"ResourceShare": {
"base": "Describes a resource share.
",
"refs": {
"CreateResourceShareResponse$resourceShare": "Information about the resource share.
",
"ResourceShareList$member": null,
"UpdateResourceShareResponse$resourceShare": "Information about the resource share.
"
}
},
"ResourceShareArnList": {
"base": null,
"refs": {
"GetResourceShareAssociationsRequest$resourceShareArns": "The Amazon Resource Names (ARN) of the resource shares.
",
"GetResourceShareInvitationsRequest$resourceShareArns": "The Amazon Resource Names (ARN) of the resource shares.
",
"GetResourceSharesRequest$resourceShareArns": "The Amazon Resource Names (ARN) of the resource shares.
",
"ListPrincipalsRequest$resourceShareArns": "The Amazon Resource Names (ARN) of the resource shares.
",
"ListResourcesRequest$resourceShareArns": "The Amazon Resource Names (ARN) of the resource shares.
"
}
},
"ResourceShareAssociation": {
"base": "Describes an association with a resource share.
",
"refs": {
"ResourceShareAssociationList$member": null
}
},
"ResourceShareAssociationList": {
"base": null,
"refs": {
"AssociateResourceShareResponse$resourceShareAssociations": "Information about the associations.
",
"DisassociateResourceShareResponse$resourceShareAssociations": "Information about the associations.
",
"GetResourceShareAssociationsResponse$resourceShareAssociations": "Information about the association.
",
"ResourceShareInvitation$resourceShareAssociations": "The resources associated with the resource share.
"
}
},
"ResourceShareAssociationStatus": {
"base": null,
"refs": {
"GetResourceShareAssociationsRequest$associationStatus": "The status of the association.
",
"ResourceShareAssociation$status": "The status of the association.
"
}
},
"ResourceShareAssociationType": {
"base": null,
"refs": {
"GetResourceShareAssociationsRequest$associationType": "The association type.
",
"ResourceShareAssociation$associationType": "The association type.
"
}
},
"ResourceShareInvitation": {
"base": "Describes an invitation to join a resource share.
",
"refs": {
"AcceptResourceShareInvitationResponse$resourceShareInvitation": "Information about the invitation.
",
"RejectResourceShareInvitationResponse$resourceShareInvitation": "Information about the invitation.
",
"ResourceShareInvitationList$member": null
}
},
"ResourceShareInvitationAlreadyAcceptedException": {
"base": "The invitation was already accepted.
",
"refs": {
}
},
"ResourceShareInvitationAlreadyRejectedException": {
"base": "The invitation was already rejected.
",
"refs": {
}
},
"ResourceShareInvitationArnList": {
"base": null,
"refs": {
"GetResourceShareInvitationsRequest$resourceShareInvitationArns": "The Amazon Resource Names (ARN) of the invitations.
"
}
},
"ResourceShareInvitationArnNotFoundException": {
"base": "The Amazon Resource Name (ARN) for an invitation was not found.
",
"refs": {
}
},
"ResourceShareInvitationExpiredException": {
"base": "The invitation is expired.
",
"refs": {
}
},
"ResourceShareInvitationList": {
"base": null,
"refs": {
"GetResourceShareInvitationsResponse$resourceShareInvitations": "Information about the invitations.
"
}
},
"ResourceShareInvitationStatus": {
"base": null,
"refs": {
"ResourceShareInvitation$status": "The status of the invitation.
"
}
},
"ResourceShareLimitExceededException": {
"base": "The requested resource share exceeds the limit for your account.
",
"refs": {
}
},
"ResourceShareList": {
"base": null,
"refs": {
"GetResourceSharesResponse$resourceShares": "Information about the resource shares.
"
}
},
"ResourceShareStatus": {
"base": null,
"refs": {
"GetResourceSharesRequest$resourceShareStatus": "The status of the resource share.
",
"ResourceShare$status": "The status of the resource share.
"
}
},
"ResourceStatus": {
"base": null,
"refs": {
"Resource$status": "The status of the resource.
"
}
},
"ServerInternalException": {
"base": "The service could not respond to the request due to an internal problem.
",
"refs": {
}
},
"ServiceUnavailableException": {
"base": "The service is not available.
",
"refs": {
}
},
"String": {
"base": null,
"refs": {
"AcceptResourceShareInvitationRequest$resourceShareInvitationArn": "The Amazon Resource Name (ARN) of the invitation.
",
"AcceptResourceShareInvitationRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"AcceptResourceShareInvitationResponse$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"AssociateResourceShareRequest$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"AssociateResourceShareRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"AssociateResourceShareResponse$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"CreateResourceShareRequest$name": "The name of the resource share.
",
"CreateResourceShareRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"CreateResourceShareResponse$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"DeleteResourceShareRequest$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"DeleteResourceShareRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"DeleteResourceShareResponse$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"DisassociateResourceShareRequest$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"DisassociateResourceShareRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"DisassociateResourceShareResponse$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"GetResourcePoliciesRequest$principal": "The principal.
",
"GetResourcePoliciesRequest$nextToken": "The token for the next page of results.
",
"GetResourcePoliciesResponse$nextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
",
"GetResourceShareAssociationsRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
",
"GetResourceShareAssociationsRequest$principal": "The principal.
",
"GetResourceShareAssociationsRequest$nextToken": "The token for the next page of results.
",
"GetResourceShareAssociationsResponse$nextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
",
"GetResourceShareInvitationsRequest$nextToken": "The token for the next page of results.
",
"GetResourceShareInvitationsResponse$nextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
",
"GetResourceSharesRequest$name": "The name of the resource share.
",
"GetResourceSharesRequest$nextToken": "The token for the next page of results.
",
"GetResourceSharesResponse$nextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
",
"IdempotentParameterMismatchException$message": null,
"InvalidClientTokenException$message": null,
"InvalidMaxResultsException$message": null,
"InvalidNextTokenException$message": null,
"InvalidParameterException$message": null,
"InvalidResourceTypeException$message": null,
"InvalidStateTransitionException$message": null,
"ListPrincipalsRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
",
"ListPrincipalsRequest$resourceType": "The resource type.
",
"ListPrincipalsRequest$nextToken": "The token for the next page of results.
",
"ListPrincipalsResponse$nextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
",
"ListResourcesRequest$principal": "The principal.
",
"ListResourcesRequest$resourceType": "The resource type.
",
"ListResourcesRequest$nextToken": "The token for the next page of results.
",
"ListResourcesResponse$nextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
",
"MalformedArnException$message": null,
"MissingRequiredParameterException$message": null,
"OperationNotPermittedException$message": null,
"Principal$id": "The ID of the principal.
",
"Principal$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"PrincipalArnOrIdList$member": null,
"RejectResourceShareInvitationRequest$resourceShareInvitationArn": "The Amazon Resource Name (ARN) of the invitation.
",
"RejectResourceShareInvitationRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"RejectResourceShareInvitationResponse$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"Resource$arn": "The Amazon Resource Name (ARN) of the resource.
",
"Resource$type": "The resource type.
",
"Resource$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"Resource$statusMessage": "A message about the status of the resource.
",
"ResourceArnList$member": null,
"ResourceArnNotFoundException$message": null,
"ResourceShare$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"ResourceShare$name": "The name of the resource share.
",
"ResourceShare$owningAccountId": "The ID of the AWS account that owns the resource share.
",
"ResourceShare$statusMessage": "A message about the status of the resource share.
",
"ResourceShareArnList$member": null,
"ResourceShareAssociation$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"ResourceShareAssociation$associatedEntity": "The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.
",
"ResourceShareAssociation$statusMessage": "A message about the status of the association.
",
"ResourceShareInvitation$resourceShareInvitationArn": "The Amazon Resource Name (ARN) of the invitation.
",
"ResourceShareInvitation$resourceShareName": "The name of the resource share.
",
"ResourceShareInvitation$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"ResourceShareInvitation$senderAccountId": "The ID of the AWS account that sent the invitation.
",
"ResourceShareInvitation$receiverAccountId": "The ID of the AWS account that received the invitation.
",
"ResourceShareInvitationAlreadyAcceptedException$message": null,
"ResourceShareInvitationAlreadyRejectedException$message": null,
"ResourceShareInvitationArnList$member": null,
"ResourceShareInvitationArnNotFoundException$message": null,
"ResourceShareInvitationExpiredException$message": null,
"ResourceShareLimitExceededException$message": null,
"ServerInternalException$message": null,
"ServiceUnavailableException$message": null,
"TagLimitExceededException$message": null,
"TagResourceRequest$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"UnknownResourceException$message": null,
"UntagResourceRequest$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"UpdateResourceShareRequest$resourceShareArn": "The Amazon Resource Name (ARN) of the resource share.
",
"UpdateResourceShareRequest$name": "The name of the resource share.
",
"UpdateResourceShareRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
",
"UpdateResourceShareResponse$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
"
}
},
"Tag": {
"base": "Information about a tag.
",
"refs": {
"TagList$member": null
}
},
"TagFilter": {
"base": "Used to filter information based on tags.
",
"refs": {
"TagFilters$member": null
}
},
"TagFilters": {
"base": null,
"refs": {
"GetResourceSharesRequest$tagFilters": "One or more tag filters.
"
}
},
"TagKey": {
"base": null,
"refs": {
"Tag$key": "The key of the tag.
",
"TagFilter$tagKey": "The tag key.
",
"TagKeyList$member": null
}
},
"TagKeyList": {
"base": null,
"refs": {
"UntagResourceRequest$tagKeys": "The tag keys of the tags to remove.
"
}
},
"TagLimitExceededException": {
"base": "The requested tags exceed the limit for your account.
",
"refs": {
}
},
"TagList": {
"base": null,
"refs": {
"CreateResourceShareRequest$tags": "One or more tags.
",
"ResourceShare$tags": "The tags for the resource share.
",
"TagResourceRequest$tags": "One or more tags.
"
}
},
"TagResourceRequest": {
"base": null,
"refs": {
}
},
"TagResourceResponse": {
"base": null,
"refs": {
}
},
"TagValue": {
"base": null,
"refs": {
"Tag$value": "The value of the tag.
",
"TagValueList$member": null
}
},
"TagValueList": {
"base": null,
"refs": {
"TagFilter$tagValues": "The tag values.
"
}
},
"UnknownResourceException": {
"base": "A specified resource was not found.
",
"refs": {
}
},
"UntagResourceRequest": {
"base": null,
"refs": {
}
},
"UntagResourceResponse": {
"base": null,
"refs": {
}
},
"UpdateResourceShareRequest": {
"base": null,
"refs": {
}
},
"UpdateResourceShareResponse": {
"base": null,
"refs": {
}
}
}
}