"documentation":"<p>Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.</p> <p>Use this API action to promote the resource share. When you promote the resource share, it becomes:</p> <ul> <li> <p>Visible to all principals that it is shared with.</p> </li> <li> <p>Modifiable in AWS RAM.</p> </li> </ul>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resource share.</p>"
},
"permissionArn":{
"shape":"String",
"documentation":"<p>The ARN of the AWS RAM permission to associate with the resource share.</p>"
},
"replace":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the permission should replace the permissions that are currently associated with the resource share. Use <code>true</code> to replace the current permissions. Use <code>false</code> to add the permission to the current permission.</p>"
},
"clientToken":{
"shape":"String",
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
}
}
},
"AssociateResourceSharePermissionResponse":{
"type":"structure",
"members":{
"returnValue":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the request succeeded.</p>"
},
"clientToken":{
"shape":"String",
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resource share.</p>"
},
"resourceArns":{
"shape":"ResourceArnList",
"documentation":"<p>The Amazon Resource Names (ARN) of the resources.</p>"
},
"principals":{
"shape":"PrincipalArnOrIdList",
"documentation":"<p>The principals.</p>"
},
"clientToken":{
"shape":"String",
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
}
}
},
"AssociateResourceShareResponse":{
"type":"structure",
"members":{
"resourceShareAssociations":{
"shape":"ResourceShareAssociationList",
"documentation":"<p>Information about the associations.</p>"
},
"clientToken":{
"shape":"String",
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
}
}
},
"Boolean":{"type":"boolean"},
"CreateResourceShareRequest":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the resource share.</p>"
},
"resourceArns":{
"shape":"ResourceArnList",
"documentation":"<p>The Amazon Resource Names (ARN) of the resources to associate with the resource share.</p>"
},
"principals":{
"shape":"PrincipalArnOrIdList",
"documentation":"<p>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.</p>"
"documentation":"<p>The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type.</p>"
"documentation":"<p>The Amazon Resource Names (ARN) of the resources.</p>"
},
"principal":{
"shape":"String",
"documentation":"<p>The principal.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"GetResourcePoliciesResponse":{
"type":"structure",
"members":{
"policies":{
"shape":"PolicyList",
"documentation":"<p>A key policy document, in JSON format.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
"documentation":"<p>The association type. Specify <code>PRINCIPAL</code> to list the principals that are associated with the specified resource share. Specify <code>RESOURCE</code> to list the resources that are associated with the specified resource share.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is <code>PRINCIPAL</code>.</p>"
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"GetResourceShareInvitationsRequest":{
"type":"structure",
"members":{
"resourceShareInvitationArns":{
"shape":"ResourceShareInvitationArnList",
"documentation":"<p>The Amazon Resource Names (ARN) of the invitations.</p>"
},
"resourceShareArns":{
"shape":"ResourceShareArnList",
"documentation":"<p>The Amazon Resource Names (ARN) of the resource shares.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"GetResourceShareInvitationsResponse":{
"type":"structure",
"members":{
"resourceShareInvitations":{
"shape":"ResourceShareInvitationList",
"documentation":"<p>Information about the invitations.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"GetResourceSharesRequest":{
"type":"structure",
"required":["resourceOwner"],
"members":{
"resourceShareArns":{
"shape":"ResourceShareArnList",
"documentation":"<p>The Amazon Resource Names (ARN) of the resource shares.</p>"
},
"resourceShareStatus":{
"shape":"ResourceShareStatus",
"documentation":"<p>The status of the resource share.</p>"
},
"resourceOwner":{
"shape":"ResourceOwner",
"documentation":"<p>The type of owner.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>The name of the resource share.</p>"
},
"tagFilters":{
"shape":"TagFilters",
"documentation":"<p>One or more tag filters.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"GetResourceSharesResponse":{
"type":"structure",
"members":{
"resourceShares":{
"shape":"ResourceShareList",
"documentation":"<p>Information about the resource shares.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"IdempotentParameterMismatchException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>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.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the invitation.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"ListPendingInvitationResourcesResponse":{
"type":"structure",
"members":{
"resources":{
"shape":"ResourceList",
"documentation":"<p>Information about the resources included the resource share.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
"documentation":"<p>Specifies the resource type for which to list permissions. For example, to list only permissions that apply to EC2 subnets, specify <code>ec2:Subnet</code>.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"ListPermissionsResponse":{
"type":"structure",
"members":{
"permissions":{
"shape":"ResourceSharePermissionList",
"documentation":"<p>Information about the permissions.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
"documentation":"<p>The Amazon Resource Names (ARN) of the resource shares.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"ListPrincipalsResponse":{
"type":"structure",
"members":{
"principals":{
"shape":"PrincipalList",
"documentation":"<p>The principals.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resource share.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"ListResourceSharePermissionsResponse":{
"type":"structure",
"members":{
"permissions":{
"shape":"ResourceSharePermissionList",
"documentation":"<p>The permissions associated with the resource share.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"ListResourceTypesResponse":{
"type":"structure",
"members":{
"resourceTypes":{
"shape":"ServiceNameAndResourceTypeList",
"documentation":"<p>The shareable resource types supported by AWS RAM.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
"documentation":"<p>The Amazon Resource Names (ARN) of the resources.</p>"
},
"resourceShareArns":{
"shape":"ResourceShareArnList",
"documentation":"<p>The Amazon Resource Names (ARN) of the resource shares.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"ListResourcesResponse":{
"type":"structure",
"members":{
"resources":{
"shape":"ResourceList",
"documentation":"<p>Information about the resources.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"MalformedArnException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The format of an Amazon Resource Name (ARN) is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"MaxResults":{
"type":"integer",
"max":500,
"min":1
},
"MissingRequiredParameterException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>A required input parameter is missing.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"OperationNotPermittedException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The requested operation is not permitted.</p>",
"documentation":"<p>Indicates how the resource share was created. Possible values include:</p> <ul> <li> <p> <code>CREATED_FROM_POLICY</code> - Indicates that the resource share was created from an AWS Identity and Access Management (AWS IAM) policy attached to a resource. These resource shares are visible only to the AWS account that created it. They cannot be modified in AWS RAM.</p> </li> <li> <p> <code>PROMOTING_TO_STANDARD</code> - The resource share is in the process of being promoted. For more information, see <a>PromoteResourceShareCreatedFromPolicy</a>.</p> </li> <li> <p> <code>STANDARD</code> - Indicates that the resource share was created in AWS RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in AWS RAM.</p> </li> </ul>"
"documentation":"<p>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.</p>"
},
"associationType":{
"shape":"ResourceShareAssociationType",
"documentation":"<p>The association type.</p>"
},
"status":{
"shape":"ResourceShareAssociationStatus",
"documentation":"<p>The status of the association.</p>"
},
"statusMessage":{
"shape":"String",
"documentation":"<p>A message about the status of the association.</p>"
},
"creationTime":{
"shape":"DateTime",
"documentation":"<p>The time when the association was created.</p>"
},
"lastUpdatedTime":{
"shape":"DateTime",
"documentation":"<p>The time when the association was last updated.</p>"
"documentation":"<p>To view the resources associated with a pending resource share invitation, use <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_ListPendingInvitationResources.html\"> ListPendingInvitationResources</a>.</p>",
"documentation":"<p>The ARN of the permission.</p>"
},
"version":{
"shape":"String",
"documentation":"<p>The identifier for the version of the permission.</p>"
},
"defaultVersion":{
"shape":"Boolean",
"documentation":"<p>The identifier for the version of the permission that is set as the default version.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>The name of the permission.</p>"
},
"resourceType":{
"shape":"String",
"documentation":"<p>The resource type to which the permission applies.</p>"
},
"permission":{
"shape":"String",
"documentation":"<p>The permission's effect and actions in JSON format. The <code>effect</code> indicates whether the actions are allowed or denied. The <code>actions</code> list the API actions to which the principal is granted or denied access.</p>"
},
"creationTime":{
"shape":"DateTime",
"documentation":"<p>The date and time when the permission was created.</p>"
},
"lastUpdatedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time when the permission was last updated.</p>"
}
},
"documentation":"<p>Information about an AWS RAM permission.</p>"
"documentation":"<p>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 resources associated with the resource share. The following principals are supported: AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWS Organizations.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/\">AWS Resource Access Manager User Guide</a>.</p>"