# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.RAM do
@moduledoc """
This is the *Resource Access Manager API Reference*.
This documentation provides
descriptions and syntax for each of the actions and data types in RAM. RAM is a
service that helps you securely share your Amazon Web Services resources to
other Amazon Web Services accounts. If
you use Organizations to manage your accounts, then you can share your resources
with your
entire organization or to organizational units (OUs). For supported resource
types, you
can also share resources with individual Identity and Access Management (IAM)
roles and users.
To learn more about RAM, see the following resources:
*
[Resource Access Manager product page](http://aws.amazon.com/ram)
*
[Resource Access Manager User
Guide](https://docs.aws.amazon.com/ram/latest/userguide/)
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
get_permission_request() :: %{
optional("permissionVersion") => integer(),
required("permissionArn") => String.t() | atom()
}
"""
@type get_permission_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_limit_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type tag_limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_unavailable_exception() :: %{
"message" => String.t() | atom()
}
"""
@type service_unavailable_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
promote_permission_created_from_policy_request() :: %{
optional("clientToken") => String.t() | atom(),
required("name") => String.t() | atom(),
required("permissionArn") => String.t() | atom()
}
"""
@type promote_permission_created_from_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_principals_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("principals") => list(String.t() | atom()),
optional("resourceArn") => String.t() | atom(),
optional("resourceShareArns") => list(String.t() | atom()),
optional("resourceType") => String.t() | atom(),
required("resourceOwner") => list(any())
}
"""
@type list_principals_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replace_permission_associations_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("fromPermissionVersion") => integer(),
required("fromPermissionArn") => String.t() | atom(),
required("toPermissionArn") => String.t() | atom()
}
"""
@type replace_permission_associations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => String.t() | atom()
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unmatched_policy_permission_exception() :: %{
"message" => String.t() | atom()
}
"""
@type unmatched_policy_permission_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resources_response() :: %{
"nextToken" => String.t() | atom(),
"resources" => list(resource())
}
"""
@type list_resources_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associated_source() :: %{
"creationTime" => non_neg_integer(),
"lastUpdatedTime" => non_neg_integer(),
"resourceShareArn" => String.t() | atom(),
"sourceId" => String.t() | atom(),
"sourceType" => String.t() | atom(),
"status" => String.t() | atom(),
"statusMessage" => String.t() | atom()
}
"""
@type associated_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
promote_permission_created_from_policy_response() :: %{
"clientToken" => String.t() | atom(),
"permission" => resource_share_permission_summary()
}
"""
@type promote_permission_created_from_policy_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"key" => String.t() | atom(),
"value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
reject_resource_share_invitation_response() :: %{
"clientToken" => String.t() | atom(),
"resourceShareInvitation" => resource_share_invitation()
}
"""
@type reject_resource_share_invitation_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_permission_version_request() :: %{
optional("clientToken") => String.t() | atom(),
required("permissionArn") => String.t() | atom(),
required("policyTemplate") => String.t() | atom()
}
"""
@type create_permission_version_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_share_invitations_response() :: %{
"nextToken" => String.t() | atom(),
"resourceShareInvitations" => list(resource_share_invitation())
}
"""
@type get_resource_share_invitations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_permission_versions_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
required("permissionArn") => String.t() | atom()
}
"""
@type list_permission_versions_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_resource_share_response() :: %{
"clientToken" => String.t() | atom(),
"returnValue" => boolean()
}
"""
@type delete_resource_share_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_replace_permission_associations_work_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("status") => list(any()),
optional("workIds") => list(String.t() | atom())
}
"""
@type list_replace_permission_associations_work_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_permissions_response() :: %{
"nextToken" => String.t() | atom(),
"permissions" => list(resource_share_permission_summary())
}
"""
@type list_permissions_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_source_associations_request() :: %{
optional("associationStatus") => list(any()),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("resourceShareArns") => list(String.t() | atom()),
optional("sourceId") => String.t() | atom(),
optional("sourceType") => String.t() | atom()
}
"""
@type list_source_associations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
enable_sharing_with_aws_organization_request() :: %{}
"""
@type enable_sharing_with_aws_organization_request() :: %{}
@typedoc """
## Example:
accept_resource_share_invitation_response() :: %{
"clientToken" => String.t() | atom(),
"resourceShareInvitation" => resource_share_invitation()
}
"""
@type accept_resource_share_invitation_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
idempotent_parameter_mismatch_exception() :: %{
"message" => String.t() | atom()
}
"""
@type idempotent_parameter_mismatch_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_permission_response() :: %{
"clientToken" => String.t() | atom(),
"permission" => resource_share_permission_summary()
}
"""
@type create_permission_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_permission_response() :: %{
"permission" => resource_share_permission_detail()
}
"""
@type get_permission_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
promote_resource_share_created_from_policy_response() :: %{
"returnValue" => boolean()
}
"""
@type promote_resource_share_created_from_policy_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_permissions_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("permissionType") => list(any()),
optional("resourceType") => String.t() | atom()
}
"""
@type list_permissions_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_permission_request() :: %{
optional("clientToken") => String.t() | atom(),
required("permissionArn") => String.t() | atom()
}
"""
@type delete_permission_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_pending_invitation_resources_response() :: %{
"nextToken" => String.t() | atom(),
"resources" => list(resource())
}
"""
@type list_pending_invitation_resources_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
principal() :: %{
"creationTime" => non_neg_integer(),
"external" => boolean(),
"id" => String.t() | atom(),
"lastUpdatedTime" => non_neg_integer(),
"resourceShareArn" => String.t() | atom()
}
"""
@type principal() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
set_default_permission_version_request() :: %{
optional("clientToken") => String.t() | atom(),
required("permissionArn") => String.t() | atom(),
required("permissionVersion") => integer()
}
"""
@type set_default_permission_version_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
reject_resource_share_invitation_request() :: %{
optional("clientToken") => String.t() | atom(),
required("resourceShareInvitationArn") => String.t() | atom()
}
"""
@type reject_resource_share_invitation_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_resource_share_request() :: %{
optional("clientToken") => String.t() | atom(),
required("resourceShareArn") => String.t() | atom()
}
"""
@type delete_resource_share_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resource_types_response() :: %{
"nextToken" => String.t() | atom(),
"resourceTypes" => list(service_name_and_resource_type())
}
"""
@type list_resource_types_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_resource_share_permission_response() :: %{
"clientToken" => String.t() | atom(),
"returnValue" => boolean()
}
"""
@type associate_resource_share_permission_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_client_token_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_client_token_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_policy_violation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type tag_policy_violation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_filter() :: %{
"tagKey" => String.t() | atom(),
"tagValues" => list(String.t() | atom())
}
"""
@type tag_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
permission_limit_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type permission_limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_share_invitations_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("resourceShareArns") => list(String.t() | atom()),
optional("resourceShareInvitationArns") => list(String.t() | atom())
}
"""
@type get_resource_share_invitations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
optional("resourceArn") => String.t() | atom(),
optional("resourceShareArn") => String.t() | atom(),
required("tags") => list(tag())
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_pending_invitation_resources_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("resourceRegionScope") => list(any()),
required("resourceShareInvitationArn") => String.t() | atom()
}
"""
@type list_pending_invitation_resources_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_configuration() :: %{
"retainSharingOnAccountLeaveOrganization" => boolean()
}
"""
@type resource_share_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
invalid_state_transition_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_state_transition_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
enable_sharing_with_aws_organization_response() :: %{
"returnValue" => boolean()
}
"""
@type enable_sharing_with_aws_organization_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
list_source_associations_response() :: %{
"nextToken" => String.t() | atom(),
"sourceAssociations" => list(associated_source())
}
"""
@type list_source_associations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_shares_response() :: %{
"nextToken" => String.t() | atom(),
"resourceShares" => list(resource_share())
}
"""
@type get_resource_shares_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
permission_already_exists_exception() :: %{
"message" => String.t() | atom()
}
"""
@type permission_already_exists_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_policies_response() :: %{
"nextToken" => String.t() | atom(),
"policies" => list(String.t() | atom())
}
"""
@type get_resource_policies_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_permission_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("tags") => list(tag()),
required("name") => String.t() | atom(),
required("policyTemplate") => String.t() | atom(),
required("resourceType") => String.t() | atom()
}
"""
@type create_permission_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_permission_version_response() :: %{
"clientToken" => String.t() | atom(),
"permission" => resource_share_permission_detail()
}
"""
@type create_permission_version_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
optional("resourceArn") => String.t() | atom(),
optional("resourceShareArn") => String.t() | atom(),
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_shares_request() :: %{
optional("maxResults") => integer(),
optional("name") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("permissionArn") => String.t() | atom(),
optional("permissionVersion") => integer(),
optional("resourceShareArns") => list(String.t() | atom()),
optional("resourceShareStatus") => list(any()),
optional("tagFilters") => list(tag_filter()),
required("resourceOwner") => list(any())
}
"""
@type get_resource_shares_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
accept_resource_share_invitation_request() :: %{
optional("clientToken") => String.t() | atom(),
required("resourceShareInvitationArn") => String.t() | atom()
}
"""
@type accept_resource_share_invitation_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associated_permission() :: %{
"arn" => String.t() | atom(),
"defaultVersion" => boolean(),
"featureSet" => list(any()),
"lastUpdatedTime" => non_neg_integer(),
"permissionVersion" => String.t() | atom(),
"resourceShareArn" => String.t() | atom(),
"resourceType" => String.t() | atom(),
"status" => String.t() | atom()
}
"""
@type associated_permission() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replace_permission_associations_response() :: %{
"clientToken" => String.t() | atom(),
"replacePermissionAssociationsWork" => replace_permission_associations_work()
}
"""
@type replace_permission_associations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_permission_version_request() :: %{
optional("clientToken") => String.t() | atom(),
required("permissionArn") => String.t() | atom(),
required("permissionVersion") => integer()
}
"""
@type delete_permission_version_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
malformed_policy_template_exception() :: %{
"message" => String.t() | atom()
}
"""
@type malformed_policy_template_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_resource_share_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("principals") => list(String.t() | atom()),
optional("resourceArns") => list(String.t() | atom()),
optional("sources") => list(String.t() | atom()),
required("resourceShareArn") => String.t() | atom()
}
"""
@type disassociate_resource_share_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_invitation_arn_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_share_invitation_arn_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_resource_share_response() :: %{
"clientToken" => String.t() | atom(),
"resourceShareAssociations" => list(resource_share_association())
}
"""
@type disassociate_resource_share_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_name_and_resource_type() :: %{
"resourceRegionScope" => list(any()),
"resourceType" => String.t() | atom(),
"serviceName" => String.t() | atom()
}
"""
@type service_name_and_resource_type() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_resource_share_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("principals") => list(String.t() | atom()),
optional("resourceArns") => list(String.t() | atom()),
optional("sources") => list(String.t() | atom()),
required("resourceShareArn") => String.t() | atom()
}
"""
@type associate_resource_share_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_permission_associations_request() :: %{
optional("associationStatus") => list(any()),
optional("defaultVersion") => boolean(),
optional("featureSet") => list(any()),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("permissionArn") => String.t() | atom(),
optional("permissionVersion") => integer(),
optional("resourceType") => String.t() | atom()
}
"""
@type list_permission_associations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
permission_versions_limit_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type permission_versions_limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_next_token_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_next_token_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_resource_share_request() :: %{
optional("allowExternalPrincipals") => boolean(),
optional("clientToken") => String.t() | atom(),
optional("name") => String.t() | atom(),
required("resourceShareArn") => String.t() | atom()
}
"""
@type update_resource_share_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resource_types_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("resourceRegionScope") => list(any())
}
"""
@type list_resource_types_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unknown_resource_exception() :: %{
"message" => String.t() | atom()
}
"""
@type unknown_resource_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_resource_share_permission_request() :: %{
optional("clientToken") => String.t() | atom(),
optional("permissionVersion") => integer(),
optional("replace") => boolean(),
required("permissionArn") => String.t() | atom(),
required("resourceShareArn") => String.t() | atom()
}
"""
@type associate_resource_share_permission_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replace_permission_associations_work() :: %{
"creationTime" => non_neg_integer(),
"fromPermissionArn" => String.t() | atom(),
"fromPermissionVersion" => String.t() | atom(),
"id" => String.t() | atom(),
"lastUpdatedTime" => non_neg_integer(),
"status" => list(any()),
"statusMessage" => String.t() | atom(),
"toPermissionArn" => String.t() | atom(),
"toPermissionVersion" => String.t() | atom()
}
"""
@type replace_permission_associations_work() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_resource_share_permission_response() :: %{
"clientToken" => String.t() | atom(),
"returnValue" => boolean()
}
"""
@type disassociate_resource_share_permission_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_invitation_expired_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_share_invitation_expired_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_max_results_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_max_results_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resource_share_permissions_response() :: %{
"nextToken" => String.t() | atom(),
"permissions" => list(resource_share_permission_summary())
}
"""
@type list_resource_share_permissions_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
operation_not_permitted_exception() :: %{
"message" => String.t() | atom()
}
"""
@type operation_not_permitted_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
promote_resource_share_created_from_policy_request() :: %{
required("resourceShareArn") => String.t() | atom()
}
"""
@type promote_resource_share_created_from_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_share_associations_response() :: %{
"nextToken" => String.t() | atom(),
"resourceShareAssociations" => list(resource_share_association())
}
"""
@type get_resource_share_associations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_limit_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_share_limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
missing_required_parameter_exception() :: %{
"message" => String.t() | atom()
}
"""
@type missing_required_parameter_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_resource_share_response() :: %{
"clientToken" => String.t() | atom(),
"resourceShare" => resource_share()
}
"""
@type create_resource_share_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_permission_detail() :: %{
"arn" => String.t() | atom(),
"creationTime" => non_neg_integer(),
"defaultVersion" => boolean(),
"featureSet" => list(any()),
"isResourceTypeDefault" => boolean(),
"lastUpdatedTime" => non_neg_integer(),
"name" => String.t() | atom(),
"permission" => String.t() | atom(),
"permissionType" => list(any()),
"resourceType" => String.t() | atom(),
"status" => list(any()),
"tags" => list(tag()),
"version" => String.t() | atom()
}
"""
@type resource_share_permission_detail() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_principals_response() :: %{
"nextToken" => String.t() | atom(),
"principals" => list(principal())
}
"""
@type list_principals_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_replace_permission_associations_work_response() :: %{
"nextToken" => String.t() | atom(),
"replacePermissionAssociationsWorks" => list(replace_permission_associations_work())
}
"""
@type list_replace_permission_associations_work_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_resource_share_permission_request() :: %{
optional("clientToken") => String.t() | atom(),
required("permissionArn") => String.t() | atom(),
required("resourceShareArn") => String.t() | atom()
}
"""
@type disassociate_resource_share_permission_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_resource_share_response() :: %{
"clientToken" => String.t() | atom(),
"resourceShare" => resource_share()
}
"""
@type update_resource_share_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_permission_summary() :: %{
"arn" => String.t() | atom(),
"creationTime" => non_neg_integer(),
"defaultVersion" => boolean(),
"featureSet" => list(any()),
"isResourceTypeDefault" => boolean(),
"lastUpdatedTime" => non_neg_integer(),
"name" => String.t() | atom(),
"permissionType" => list(any()),
"resourceType" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => list(tag()),
"version" => String.t() | atom()
}
"""
@type resource_share_permission_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resources_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("principal") => String.t() | atom(),
optional("resourceArns") => list(String.t() | atom()),
optional("resourceRegionScope") => list(any()),
optional("resourceShareArns") => list(String.t() | atom()),
optional("resourceType") => String.t() | atom(),
required("resourceOwner") => list(any())
}
"""
@type list_resources_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_share_associations_request() :: %{
optional("associationStatus") => list(any()),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("principal") => String.t() | atom(),
optional("resourceArn") => String.t() | atom(),
optional("resourceShareArns") => list(String.t() | atom()),
required("associationType") => list(any())
}
"""
@type get_resource_share_associations_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_resource_share_response() :: %{
"clientToken" => String.t() | atom(),
"resourceShareAssociations" => list(resource_share_association())
}
"""
@type associate_resource_share_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_resource_share_permissions_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
required("resourceShareArn") => String.t() | atom()
}
"""
@type list_resource_share_permissions_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_invitation() :: %{
"invitationTimestamp" => non_neg_integer(),
"receiverAccountId" => String.t() | atom(),
"receiverArn" => String.t() | atom(),
"resourceShareArn" => String.t() | atom(),
"resourceShareAssociations" => list(resource_share_association()),
"resourceShareInvitationArn" => String.t() | atom(),
"resourceShareName" => String.t() | atom(),
"senderAccountId" => String.t() | atom(),
"status" => list(any())
}
"""
@type resource_share_invitation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_arn_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_arn_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_parameter_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_parameter_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
server_internal_exception() :: %{
"message" => String.t() | atom()
}
"""
@type server_internal_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_invitation_already_rejected_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_share_invitation_already_rejected_exception() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
set_default_permission_version_response() :: %{
"clientToken" => String.t() | atom(),
"returnValue" => boolean()
}
"""
@type set_default_permission_version_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_resource_share_request() :: %{
optional("allowExternalPrincipals") => boolean(),
optional("clientToken") => String.t() | atom(),
optional("permissionArns") => list(String.t() | atom()),
optional("principals") => list(String.t() | atom()),
optional("resourceArns") => list(String.t() | atom()),
optional("resourceShareConfiguration") => resource_share_configuration(),
optional("sources") => list(String.t() | atom()),
optional("tags") => list(tag()),
required("name") => String.t() | atom()
}
"""
@type create_resource_share_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_policy_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_policy_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource() :: %{
"arn" => String.t() | atom(),
"creationTime" => non_neg_integer(),
"lastUpdatedTime" => non_neg_integer(),
"resourceGroupArn" => String.t() | atom(),
"resourceRegionScope" => list(any()),
"resourceShareArn" => String.t() | atom(),
"status" => list(any()),
"statusMessage" => String.t() | atom(),
"type" => String.t() | atom()
}
"""
@type resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_invitation_already_accepted_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_share_invitation_already_accepted_exception() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
list_permission_versions_response() :: %{
"nextToken" => String.t() | atom(),
"permissions" => list(resource_share_permission_summary())
}
"""
@type list_permission_versions_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_policies_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("principal") => String.t() | atom(),
required("resourceArns") => list(String.t() | atom())
}
"""
@type get_resource_policies_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share() :: %{
"allowExternalPrincipals" => boolean(),
"creationTime" => non_neg_integer(),
"featureSet" => list(any()),
"lastUpdatedTime" => non_neg_integer(),
"name" => String.t() | atom(),
"owningAccountId" => String.t() | atom(),
"resourceShareArn" => String.t() | atom(),
"resourceShareConfiguration" => resource_share_configuration(),
"status" => list(any()),
"statusMessage" => String.t() | atom(),
"tags" => list(tag())
}
"""
@type resource_share() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_permission_version_response() :: %{
"clientToken" => String.t() | atom(),
"permissionStatus" => list(any()),
"returnValue" => boolean()
}
"""
@type delete_permission_version_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_permission_response() :: %{
"clientToken" => String.t() | atom(),
"permissionStatus" => list(any()),
"returnValue" => boolean()
}
"""
@type delete_permission_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
malformed_arn_exception() :: %{
"message" => String.t() | atom()
}
"""
@type malformed_arn_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_share_association() :: %{
"associatedEntity" => String.t() | atom(),
"associationType" => list(any()),
"creationTime" => non_neg_integer(),
"external" => boolean(),
"lastUpdatedTime" => non_neg_integer(),
"resourceShareArn" => String.t() | atom(),
"resourceShareName" => String.t() | atom(),
"status" => list(any()),
"statusMessage" => String.t() | atom()
}
"""
@type resource_share_association() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_permission_associations_response() :: %{
"nextToken" => String.t() | atom(),
"permissions" => list(associated_permission())
}
"""
@type list_permission_associations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_resource_type_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_resource_type_exception() :: %{(String.t() | atom()) => any()}
@type accept_resource_share_invitation_errors() ::
malformed_arn_exception()
| resource_share_invitation_already_accepted_exception()
| resource_share_invitation_already_rejected_exception()
| server_internal_exception()
| operation_not_permitted_exception()
| resource_share_invitation_expired_exception()
| resource_share_invitation_arn_not_found_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
@type associate_resource_share_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| resource_share_limit_exceeded_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_state_transition_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| throttling_exception()
| service_unavailable_exception()
@type associate_resource_share_permission_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_client_token_exception()
| service_unavailable_exception()
@type create_permission_errors() ::
invalid_policy_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| malformed_policy_template_exception()
| permission_already_exists_exception()
| permission_limit_exceeded_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
@type create_permission_version_errors() ::
malformed_arn_exception()
| invalid_policy_exception()
| server_internal_exception()
| invalid_parameter_exception()
| unknown_resource_exception()
| permission_versions_limit_exceeded_exception()
| malformed_policy_template_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
@type create_resource_share_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| resource_share_limit_exceeded_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_state_transition_exception()
| tag_policy_violation_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| throttling_exception()
| service_unavailable_exception()
| tag_limit_exceeded_exception()
@type delete_permission_errors() ::
malformed_arn_exception()
| server_internal_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
@type delete_permission_version_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
@type delete_resource_share_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_state_transition_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| throttling_exception()
| service_unavailable_exception()
@type disassociate_resource_share_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| resource_share_limit_exceeded_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_state_transition_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| throttling_exception()
| service_unavailable_exception()
@type disassociate_resource_share_permission_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_state_transition_exception()
| invalid_client_token_exception()
| service_unavailable_exception()
@type enable_sharing_with_aws_organization_errors() ::
server_internal_exception()
| operation_not_permitted_exception()
| service_unavailable_exception()
@type get_permission_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| service_unavailable_exception()
@type get_resource_policies_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| resource_arn_not_found_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type get_resource_share_associations_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type get_resource_share_invitations_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| invalid_max_results_exception()
| unknown_resource_exception()
| invalid_next_token_exception()
| resource_share_invitation_arn_not_found_exception()
| service_unavailable_exception()
@type get_resource_shares_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| unknown_resource_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_pending_invitation_resources_errors() ::
malformed_arn_exception()
| resource_share_invitation_already_rejected_exception()
| server_internal_exception()
| invalid_parameter_exception()
| missing_required_parameter_exception()
| resource_share_invitation_expired_exception()
| invalid_next_token_exception()
| resource_share_invitation_arn_not_found_exception()
| service_unavailable_exception()
@type list_permission_associations_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_permission_versions_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_permissions_errors() ::
server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_principals_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| unknown_resource_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_replace_permission_associations_work_errors() ::
server_internal_exception()
| invalid_parameter_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_resource_share_permissions_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_resource_types_errors() ::
server_internal_exception()
| invalid_parameter_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_resources_errors() ::
invalid_resource_type_exception()
| malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| unknown_resource_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type list_source_associations_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| unknown_resource_exception()
| invalid_next_token_exception()
| service_unavailable_exception()
@type promote_permission_created_from_policy_errors() ::
malformed_arn_exception()
| invalid_policy_exception()
| server_internal_exception()
| invalid_parameter_exception()
| missing_required_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| service_unavailable_exception()
@type promote_resource_share_created_from_policy_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| missing_required_parameter_exception()
| resource_share_limit_exceeded_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_state_transition_exception()
| unmatched_policy_permission_exception()
| service_unavailable_exception()
@type reject_resource_share_invitation_errors() ::
malformed_arn_exception()
| resource_share_invitation_already_accepted_exception()
| resource_share_invitation_already_rejected_exception()
| server_internal_exception()
| operation_not_permitted_exception()
| resource_share_invitation_expired_exception()
| resource_share_invitation_arn_not_found_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
@type replace_permission_associations_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
@type set_default_permission_version_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| unknown_resource_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
@type tag_resource_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| resource_arn_not_found_exception()
| unknown_resource_exception()
| tag_policy_violation_exception()
| service_unavailable_exception()
| tag_limit_exceeded_exception()
@type untag_resource_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| unknown_resource_exception()
| service_unavailable_exception()
@type update_resource_share_errors() ::
malformed_arn_exception()
| server_internal_exception()
| invalid_parameter_exception()
| missing_required_parameter_exception()
| operation_not_permitted_exception()
| unknown_resource_exception()
| invalid_client_token_exception()
| idempotent_parameter_mismatch_exception()
| service_unavailable_exception()
def metadata do
%{
api_version: "2018-01-04",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "ram",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "RAM",
signature_version: "v4",
signing_name: "ram",
target_prefix: nil
}
end
@doc """
Accepts an invitation to a resource share from another Amazon Web Services
account.
After you accept the
invitation, the resources included in the resource share are available to
interact with in the
relevant Amazon Web Services Management Consoles and tools.
"""
@spec accept_resource_share_invitation(
map(),
accept_resource_share_invitation_request(),
list()
) ::
{:ok, accept_resource_share_invitation_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, accept_resource_share_invitation_errors()}
def accept_resource_share_invitation(%Client{} = client, input, options \\ []) do
url_path = "/acceptresourceshareinvitation"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds the specified list of principals, resources, and source constraints to a
resource share.
Principals that
already have access to this resource share immediately receive access to the
added resources.
Newly added principals immediately receive access to the resources shared in
this resource share.
"""
@spec associate_resource_share(map(), associate_resource_share_request(), list()) ::
{:ok, associate_resource_share_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_resource_share_errors()}
def associate_resource_share(%Client{} = client, input, options \\ []) do
url_path = "/associateresourceshare"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds or replaces the RAM permission for a resource type included in a resource
share.
You can
have exactly one permission associated with each resource type in the resource
share. You can add
a new RAM permission only if there are currently no resources of that resource
type
currently in the resource share.
"""
@spec associate_resource_share_permission(
map(),
associate_resource_share_permission_request(),
list()
) ::
{:ok, associate_resource_share_permission_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_resource_share_permission_errors()}
def associate_resource_share_permission(%Client{} = client, input, options \\ []) do
url_path = "/associateresourcesharepermission"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a customer managed permission for a specified resource type that you can
attach to resource shares.
It is created in the Amazon Web Services Region in which you call the operation.
"""
@spec create_permission(map(), create_permission_request(), list()) ::
{:ok, create_permission_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_permission_errors()}
def create_permission(%Client{} = client, input, options \\ []) do
url_path = "/createpermission"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new version of the specified customer managed permission.
The new version is automatically set as
the default version of the customer managed permission. New resource shares
automatically use the default
permission. Existing resource shares continue to use their original permission
versions,
but you can use `ReplacePermissionAssociations` to update them.
If the specified customer managed permission already has the maximum of 5
versions, then
you must delete one of the existing versions before you can create a new one.
"""
@spec create_permission_version(map(), create_permission_version_request(), list()) ::
{:ok, create_permission_version_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_permission_version_errors()}
def create_permission_version(%Client{} = client, input, options \\ []) do
url_path = "/createpermissionversion"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a resource share.
You can provide a list of the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
for the resources that you
want to share, a list of principals you want to share the resources with, the
permissions to grant those principals, and optionally source constraints to
enhance security for service principal sharing.
Sharing a resource makes it available for use by principals outside of the
Amazon Web Services account that created the resource. Sharing doesn't change
any permissions or
quotas that apply to the resource in the account that created it.
"""
@spec create_resource_share(map(), create_resource_share_request(), list()) ::
{:ok, create_resource_share_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_resource_share_errors()}
def create_resource_share(%Client{} = client, input, options \\ []) do
url_path = "/createresourceshare"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the specified customer managed permission in the Amazon Web Services
Region in which you call this operation.
You
can delete a customer managed permission only if it isn't attached to any
resource share. The operation deletes all
versions associated with the customer managed permission.
"""
@spec delete_permission(map(), delete_permission_request(), list()) ::
{:ok, delete_permission_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_permission_errors()}
def delete_permission(%Client{} = client, input, options \\ []) do
url_path = "/deletepermission"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"},
{"permissionArn", "permissionArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes one version of a customer managed permission.
The version you specify must not be attached to any
resource share and must not be the default version for the permission.
If a customer managed permission has the maximum of 5 versions, then you must
delete at
least one version before you can create another.
"""
@spec delete_permission_version(map(), delete_permission_version_request(), list()) ::
{:ok, delete_permission_version_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_permission_version_errors()}
def delete_permission_version(%Client{} = client, input, options \\ []) do
url_path = "/deletepermissionversion"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"},
{"permissionArn", "permissionArn"},
{"permissionVersion", "permissionVersion"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the specified resource share.
This doesn't delete any of the resources that were associated with the resource
share; it
only stops the sharing of those resources through this resource share.
"""
@spec delete_resource_share(map(), delete_resource_share_request(), list()) ::
{:ok, delete_resource_share_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_resource_share_errors()}
def delete_resource_share(%Client{} = client, input, options \\ []) do
url_path = "/deleteresourceshare"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"},
{"resourceShareArn", "resourceShareArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes the specified principals, resources, or source constraints from
participating in the specified
resource share.
"""
@spec disassociate_resource_share(map(), disassociate_resource_share_request(), list()) ::
{:ok, disassociate_resource_share_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_resource_share_errors()}
def disassociate_resource_share(%Client{} = client, input, options \\ []) do
url_path = "/disassociateresourceshare"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes a managed permission from a resource share.
Permission changes take effect immediately. You can
remove a managed permission from a resource share only if there are currently no
resources of the relevant
resource type currently attached to the resource share.
"""
@spec disassociate_resource_share_permission(
map(),
disassociate_resource_share_permission_request(),
list()
) ::
{:ok, disassociate_resource_share_permission_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_resource_share_permission_errors()}
def disassociate_resource_share_permission(%Client{} = client, input, options \\ []) do
url_path = "/disassociateresourcesharepermission"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Enables resource sharing within your organization in Organizations.
This operation creates
a service-linked role called `AWSServiceRoleForResourceAccessManager` that has
the IAM managed policy
named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM
to retrieve information about
the organization and its structure. This lets you share resources with all of
the
accounts in the calling account's organization by specifying the organization
ID, or all
of the accounts in an organizational unit (OU) by specifying the OU ID. Until
you enable
sharing within the organization, you can specify only individual Amazon Web
Services accounts, or for
supported resource types, IAM roles and users.
You must call this operation from an IAM role or user in the organization's
management account.
"""
@spec enable_sharing_with_aws_organization(
map(),
enable_sharing_with_aws_organization_request(),
list()
) ::
{:ok, enable_sharing_with_aws_organization_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, enable_sharing_with_aws_organization_errors()}
def enable_sharing_with_aws_organization(%Client{} = client, input, options \\ []) do
url_path = "/enablesharingwithawsorganization"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves the contents of a managed permission in JSON format.
"""
@spec get_permission(map(), get_permission_request(), list()) ::
{:ok, get_permission_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_permission_errors()}
def get_permission(%Client{} = client, input, options \\ []) do
url_path = "/getpermission"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves the resource policies for the specified resources that you own and
have
shared.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec get_resource_policies(map(), get_resource_policies_request(), list()) ::
{:ok, get_resource_policies_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_resource_policies_errors()}
def get_resource_policies(%Client{} = client, input, options \\ []) do
url_path = "/getresourcepolicies"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves the lists of resources and principals that associated for resource
shares that you
own.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec get_resource_share_associations(map(), get_resource_share_associations_request(), list()) ::
{:ok, get_resource_share_associations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_resource_share_associations_errors()}
def get_resource_share_associations(%Client{} = client, input, options \\ []) do
url_path = "/getresourceshareassociations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves details about invitations that you have received for resource shares.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec get_resource_share_invitations(map(), get_resource_share_invitations_request(), list()) ::
{:ok, get_resource_share_invitations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_resource_share_invitations_errors()}
def get_resource_share_invitations(%Client{} = client, input, options \\ []) do
url_path = "/getresourceshareinvitations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves details about the resource shares that you own or that are shared with
you.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec get_resource_shares(map(), get_resource_shares_request(), list()) ::
{:ok, get_resource_shares_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_resource_shares_errors()}
def get_resource_shares(%Client{} = client, input, options \\ []) do
url_path = "/getresourceshares"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists the resources in a resource share that is shared with you but for which
the invitation is
still `PENDING`.
That means that you haven't accepted or rejected the
invitation and the invitation hasn't expired.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec list_pending_invitation_resources(
map(),
list_pending_invitation_resources_request(),
list()
) ::
{:ok, list_pending_invitation_resources_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_pending_invitation_resources_errors()}
def list_pending_invitation_resources(%Client{} = client, input, options \\ []) do
url_path = "/listpendinginvitationresources"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists information about the managed permission and its associations to any
resource shares that use
this managed permission.
This lets you see which resource shares use which versions of the specified
managed permission.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec list_permission_associations(map(), list_permission_associations_request(), list()) ::
{:ok, list_permission_associations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_permission_associations_errors()}
def list_permission_associations(%Client{} = client, input, options \\ []) do
url_path = "/listpermissionassociations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists the available versions of the specified RAM permission.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec list_permission_versions(map(), list_permission_versions_request(), list()) ::
{:ok, list_permission_versions_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_permission_versions_errors()}
def list_permission_versions(%Client{} = client, input, options \\ []) do
url_path = "/listpermissionversions"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves a list of available RAM permissions that you can use for the supported
resource types.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec list_permissions(map(), list_permissions_request(), list()) ::
{:ok, list_permissions_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_permissions_errors()}
def list_permissions(%Client{} = client, input, options \\ []) do
url_path = "/listpermissions"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists the principals that you are sharing resources with or that are sharing
resources
with you.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec list_principals(map(), list_principals_request(), list()) ::
{:ok, list_principals_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_principals_errors()}
def list_principals(%Client{} = client, input, options \\ []) do
url_path = "/listprincipals"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves the current status of the asynchronous tasks performed by RAM when you
perform the `ReplacePermissionAssociationsWork` operation.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec list_replace_permission_associations_work(
map(),
list_replace_permission_associations_work_request(),
list()
) ::
{:ok, list_replace_permission_associations_work_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_replace_permission_associations_work_errors()}
def list_replace_permission_associations_work(%Client{} = client, input, options \\ []) do
url_path = "/listreplacepermissionassociationswork"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists the RAM permissions that are associated with a resource share.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec list_resource_share_permissions(map(), list_resource_share_permissions_request(), list()) ::
{:ok, list_resource_share_permissions_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_resource_share_permissions_errors()}
def list_resource_share_permissions(%Client{} = client, input, options \\ []) do
url_path = "/listresourcesharepermissions"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists the resource types that can be shared by RAM.
"""
@spec list_resource_types(map(), list_resource_types_request(), list()) ::
{:ok, list_resource_types_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_resource_types_errors()}
def list_resource_types(%Client{} = client, input, options \\ []) do
url_path = "/listresourcetypes"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists the resources that you added to a resource share or the resources that are
shared with
you.
Always check the `NextToken` response parameter for a `null` value
when calling a paginated operation. These operations can occasionally return an
empty set of results even when there are more
results available. The `NextToken` response parameter value is `null`
*only*
when there are no more results to display.
"""
@spec list_resources(map(), list_resources_request(), list()) ::
{:ok, list_resources_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_resources_errors()}
def list_resources(%Client{} = client, input, options \\ []) do
url_path = "/listresources"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
You 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.
"""
@spec list_source_associations(map(), list_source_associations_request(), list()) ::
{:ok, list_source_associations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_source_associations_errors()}
def list_source_associations(%Client{} = client, input, options \\ []) do
url_path = "/listsourceassociations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
When you attach a resource-based policy to a resource, RAM automatically creates
a resource share of `featureSet`=`CREATED_FROM_POLICY` with a managed permission
that
has the same IAM permissions as the original resource-based policy.
However, this type
of managed permission is visible to only the resource share owner, and the
associated resource share can't be modified by
using RAM.
This operation creates a separate, fully manageable customer managed permission
that has the same IAM
permissions as the original resource-based policy. You can associate this
customer managed permission to any
resource shares.
Before you use `PromoteResourceShareCreatedFromPolicy`, you should
first run this operation to ensure that you have an appropriate customer managed
permission that can be
associated with the promoted resource share.
The original `CREATED_FROM_POLICY` policy isn't deleted, and
resource shares using that original policy aren't automatically
updated.
You can't modify a `CREATED_FROM_POLICY` resource share so you can't
associate the new customer managed permission by using
`ReplacePermsissionAssociations`. However, if you use
`PromoteResourceShareCreatedFromPolicy`, that operation
automatically associates the fully manageable customer managed permission to the
newly promoted
`STANDARD` resource share.
After you promote a resource share, if the original `CREATED_FROM_POLICY`
managed permission has no other associations to A resource share, then RAM
automatically deletes
it.
"""
@spec promote_permission_created_from_policy(
map(),
promote_permission_created_from_policy_request(),
list()
) ::
{:ok, promote_permission_created_from_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, promote_permission_created_from_policy_errors()}
def promote_permission_created_from_policy(%Client{} = client, input, options \\ []) do
url_path = "/promotepermissioncreatedfrompolicy"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
When you attach a resource-based policy to a resource, RAM automatically creates
a resource share of `featureSet`=`CREATED_FROM_POLICY` with a managed permission
that
has the same IAM permissions as the original resource-based policy.
However, this type
of managed permission is visible to only the resource share owner, and the
associated resource share can't be modified by
using RAM.
This operation promotes the resource share to a `STANDARD` resource share that
is fully
manageable in RAM. When you promote a resource share, you can then manage the
resource share in RAM and
it becomes visible to all of the principals you shared it with.
Before you perform this operation, you should first run
`PromotePermissionCreatedFromPolicy`to ensure that you have an
appropriate customer managed permission that can be associated with this
resource share after its is promoted. If
this operation can't find a managed permission that exactly matches the existing
`CREATED_FROM_POLICY` permission, then this operation fails.
"""
@spec promote_resource_share_created_from_policy(
map(),
promote_resource_share_created_from_policy_request(),
list()
) ::
{:ok, promote_resource_share_created_from_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, promote_resource_share_created_from_policy_errors()}
def promote_resource_share_created_from_policy(%Client{} = client, input, options \\ []) do
url_path = "/promoteresourcesharecreatedfrompolicy"
headers = []
custom_headers = []
{query_params, input} =
[
{"resourceShareArn", "resourceShareArn"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Rejects an invitation to a resource share from another Amazon Web Services
account.
"""
@spec reject_resource_share_invitation(
map(),
reject_resource_share_invitation_request(),
list()
) ::
{:ok, reject_resource_share_invitation_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, reject_resource_share_invitation_errors()}
def reject_resource_share_invitation(%Client{} = client, input, options \\ []) do
url_path = "/rejectresourceshareinvitation"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates all resource shares that use a managed permission to a different managed
permission.
This operation always applies the default version of the target managed
permission. You can optionally specify that the update applies to only resource
shares that
currently use a specified version. This enables you to update to the latest
version,
without changing the which managed permission is used.
You can use this operation to update all of your resource shares to use the
current
default version of the permission by specifying the same value for the
`fromPermissionArn` and `toPermissionArn` parameters.
You can use the optional `fromPermissionVersion` parameter to update only
those resources that use a specified version of the managed permission to the
new managed
permission.
To successfully perform this operation, you must have permission to update the
resource-based policy on all affected resource types.
"""
@spec replace_permission_associations(map(), replace_permission_associations_request(), list()) ::
{:ok, replace_permission_associations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, replace_permission_associations_errors()}
def replace_permission_associations(%Client{} = client, input, options \\ []) do
url_path = "/replacepermissionassociations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Designates the specified version number as the default version for the specified
customer managed permission.
New resource shares automatically use this new default permission. Existing
resource shares continue to use their original permission version, but you can
use `ReplacePermissionAssociations` to update them.
"""
@spec set_default_permission_version(map(), set_default_permission_version_request(), list()) ::
{:ok, set_default_permission_version_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, set_default_permission_version_errors()}
def set_default_permission_version(%Client{} = client, input, options \\ []) do
url_path = "/setdefaultpermissionversion"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds the specified tag keys and values to a resource share or managed
permission.
If you choose a resource share, the
tags are attached to only the resource share, not to the resources that are in
the resource share.
The tags on a managed permission are the same for all versions of the managed
permission.
"""
@spec tag_resource(map(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
url_path = "/tagresource"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes the specified tag key and value pairs from the specified resource share
or managed permission.
"""
@spec untag_resource(map(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
url_path = "/untagresource"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Modifies some of the properties of the specified resource share.
"""
@spec update_resource_share(map(), update_resource_share_request(), list()) ::
{:ok, update_resource_share_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_resource_share_errors()}
def update_resource_share(%Client{} = client, input, options \\ []) do
url_path = "/updateresourceshare"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end