Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- IdempotentParameterMismatchException
- InvalidClientTokenException
- InvalidMaxResultsException
- InvalidNextTokenException
- InvalidParameterException
- InvalidResourceTypeException
- InvalidStateTransitionException
- MalformedArnException
- MissingRequiredParameterException
- OperationNotPermittedException
- ResourceArnNotFoundException
- ResourceShareInvitationAlreadyAcceptedException
- ResourceShareInvitationAlreadyRejectedException
- ResourceShareInvitationArnNotFoundException
- ResourceShareInvitationExpiredException
- ResourceShareLimitExceededException
- ServerInternalException
- ServiceUnavailableException
- TagLimitExceededException
- TagPolicyViolationException
- ThrottlingException
- UnknownResourceException
- Waiters
- Operations
- AcceptResourceShareInvitation
- AssociateResourceShare
- AssociateResourceSharePermission
- CreateResourceShare
- DeleteResourceShare
- DisassociateResourceShare
- DisassociateResourceSharePermission
- EnableSharingWithAwsOrganization
- GetPermission
- GetResourcePolicies (Paginated)
- GetResourceShareAssociations (Paginated)
- GetResourceShareInvitations (Paginated)
- GetResourceShares (Paginated)
- ListPendingInvitationResources
- ListPermissionVersions
- ListPermissions
- ListPrincipals (Paginated)
- ListResourceSharePermissions
- ListResourceTypes
- ListResources (Paginated)
- PromoteResourceShareCreatedFromPolicy
- RejectResourceShareInvitation
- TagResource
- UntagResource
- UpdateResourceShare
- Types
- ResourceOwner
- ResourceRegionScope
- ResourceRegionScopeFilter
- ResourceShareAssociationStatus
- ResourceShareAssociationType
- ResourceShareFeatureSet
- ResourceShareInvitationStatus
- ResourceShareStatus
- ResourceStatus
- Principal
- Resource
- ResourceShare
- ResourceShareAssociation
- ResourceShareInvitation
- ResourceSharePermissionDetail
- ResourceSharePermissionSummary
- ServiceNameAndResourceType
- Tag
- TagFilter
Derived from API version 2018-01-04
of the AWS service descriptions, licensed under Apache 2.0.
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 across Amazon Web Services accounts. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts. If you use Organizations to manage your accounts, then you share your resources with your organization or organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles an users.
To learn more about RAM, see the following resources:
Synopsis
- defaultService :: Service
- _IdempotentParameterMismatchException :: AsError a => Fold a ServiceError
- _InvalidClientTokenException :: AsError a => Fold a ServiceError
- _InvalidMaxResultsException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidResourceTypeException :: AsError a => Fold a ServiceError
- _InvalidStateTransitionException :: AsError a => Fold a ServiceError
- _MalformedArnException :: AsError a => Fold a ServiceError
- _MissingRequiredParameterException :: AsError a => Fold a ServiceError
- _OperationNotPermittedException :: AsError a => Fold a ServiceError
- _ResourceArnNotFoundException :: AsError a => Fold a ServiceError
- _ResourceShareInvitationAlreadyAcceptedException :: AsError a => Fold a ServiceError
- _ResourceShareInvitationAlreadyRejectedException :: AsError a => Fold a ServiceError
- _ResourceShareInvitationArnNotFoundException :: AsError a => Fold a ServiceError
- _ResourceShareInvitationExpiredException :: AsError a => Fold a ServiceError
- _ResourceShareLimitExceededException :: AsError a => Fold a ServiceError
- _ServerInternalException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _TagLimitExceededException :: AsError a => Fold a ServiceError
- _TagPolicyViolationException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _UnknownResourceException :: AsError a => Fold a ServiceError
- data AcceptResourceShareInvitation = AcceptResourceShareInvitation' (Maybe Text) Text
- newAcceptResourceShareInvitation :: Text -> AcceptResourceShareInvitation
- data AcceptResourceShareInvitationResponse = AcceptResourceShareInvitationResponse' (Maybe Text) (Maybe ResourceShareInvitation) Int
- newAcceptResourceShareInvitationResponse :: Int -> AcceptResourceShareInvitationResponse
- data AssociateResourceShare = AssociateResourceShare' (Maybe Text) (Maybe [Text]) (Maybe [Text]) Text
- newAssociateResourceShare :: Text -> AssociateResourceShare
- data AssociateResourceShareResponse = AssociateResourceShareResponse' (Maybe Text) (Maybe [ResourceShareAssociation]) Int
- newAssociateResourceShareResponse :: Int -> AssociateResourceShareResponse
- data AssociateResourceSharePermission = AssociateResourceSharePermission' (Maybe Text) (Maybe Int) (Maybe Bool) Text Text
- newAssociateResourceSharePermission :: Text -> Text -> AssociateResourceSharePermission
- data AssociateResourceSharePermissionResponse = AssociateResourceSharePermissionResponse' (Maybe Text) (Maybe Bool) Int
- newAssociateResourceSharePermissionResponse :: Int -> AssociateResourceSharePermissionResponse
- data CreateResourceShare = CreateResourceShare' (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text
- newCreateResourceShare :: Text -> CreateResourceShare
- data CreateResourceShareResponse = CreateResourceShareResponse' (Maybe Text) (Maybe ResourceShare) Int
- newCreateResourceShareResponse :: Int -> CreateResourceShareResponse
- data DeleteResourceShare = DeleteResourceShare' (Maybe Text) Text
- newDeleteResourceShare :: Text -> DeleteResourceShare
- data DeleteResourceShareResponse = DeleteResourceShareResponse' (Maybe Text) (Maybe Bool) Int
- newDeleteResourceShareResponse :: Int -> DeleteResourceShareResponse
- data DisassociateResourceShare = DisassociateResourceShare' (Maybe Text) (Maybe [Text]) (Maybe [Text]) Text
- newDisassociateResourceShare :: Text -> DisassociateResourceShare
- data DisassociateResourceShareResponse = DisassociateResourceShareResponse' (Maybe Text) (Maybe [ResourceShareAssociation]) Int
- newDisassociateResourceShareResponse :: Int -> DisassociateResourceShareResponse
- data DisassociateResourceSharePermission = DisassociateResourceSharePermission' (Maybe Text) Text Text
- newDisassociateResourceSharePermission :: Text -> Text -> DisassociateResourceSharePermission
- data DisassociateResourceSharePermissionResponse = DisassociateResourceSharePermissionResponse' (Maybe Text) (Maybe Bool) Int
- newDisassociateResourceSharePermissionResponse :: Int -> DisassociateResourceSharePermissionResponse
- data EnableSharingWithAwsOrganization = EnableSharingWithAwsOrganization' {
- newEnableSharingWithAwsOrganization :: EnableSharingWithAwsOrganization
- data EnableSharingWithAwsOrganizationResponse = EnableSharingWithAwsOrganizationResponse' (Maybe Bool) Int
- newEnableSharingWithAwsOrganizationResponse :: Int -> EnableSharingWithAwsOrganizationResponse
- data GetPermission = GetPermission' (Maybe Int) Text
- newGetPermission :: Text -> GetPermission
- data GetPermissionResponse = GetPermissionResponse' (Maybe ResourceSharePermissionDetail) Int
- newGetPermissionResponse :: Int -> GetPermissionResponse
- data GetResourcePolicies = GetResourcePolicies' (Maybe Natural) (Maybe Text) (Maybe Text) [Text]
- newGetResourcePolicies :: GetResourcePolicies
- data GetResourcePoliciesResponse = GetResourcePoliciesResponse' (Maybe Text) (Maybe [Text]) Int
- newGetResourcePoliciesResponse :: Int -> GetResourcePoliciesResponse
- data GetResourceShareAssociations = GetResourceShareAssociations' (Maybe ResourceShareAssociationStatus) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) ResourceShareAssociationType
- newGetResourceShareAssociations :: ResourceShareAssociationType -> GetResourceShareAssociations
- data GetResourceShareAssociationsResponse = GetResourceShareAssociationsResponse' (Maybe Text) (Maybe [ResourceShareAssociation]) Int
- newGetResourceShareAssociationsResponse :: Int -> GetResourceShareAssociationsResponse
- data GetResourceShareInvitations = GetResourceShareInvitations' (Maybe Natural) (Maybe Text) (Maybe [Text]) (Maybe [Text])
- newGetResourceShareInvitations :: GetResourceShareInvitations
- data GetResourceShareInvitationsResponse = GetResourceShareInvitationsResponse' (Maybe Text) (Maybe [ResourceShareInvitation]) Int
- newGetResourceShareInvitationsResponse :: Int -> GetResourceShareInvitationsResponse
- data GetResourceShares = GetResourceShares' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ResourceShareStatus) (Maybe [TagFilter]) ResourceOwner
- newGetResourceShares :: ResourceOwner -> GetResourceShares
- data GetResourceSharesResponse = GetResourceSharesResponse' (Maybe Text) (Maybe [ResourceShare]) Int
- newGetResourceSharesResponse :: Int -> GetResourceSharesResponse
- data ListPendingInvitationResources = ListPendingInvitationResources' (Maybe Natural) (Maybe Text) (Maybe ResourceRegionScopeFilter) Text
- newListPendingInvitationResources :: Text -> ListPendingInvitationResources
- data ListPendingInvitationResourcesResponse = ListPendingInvitationResourcesResponse' (Maybe Text) (Maybe [Resource]) Int
- newListPendingInvitationResourcesResponse :: Int -> ListPendingInvitationResourcesResponse
- data ListPermissionVersions = ListPermissionVersions' (Maybe Natural) (Maybe Text) Text
- newListPermissionVersions :: Text -> ListPermissionVersions
- data ListPermissionVersionsResponse = ListPermissionVersionsResponse' (Maybe Text) (Maybe [ResourceSharePermissionSummary]) Int
- newListPermissionVersionsResponse :: Int -> ListPermissionVersionsResponse
- data ListPermissions = ListPermissions' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListPermissions :: ListPermissions
- data ListPermissionsResponse = ListPermissionsResponse' (Maybe Text) (Maybe [ResourceSharePermissionSummary]) Int
- newListPermissionsResponse :: Int -> ListPermissionsResponse
- data ListPrincipals = ListPrincipals' (Maybe Natural) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) ResourceOwner
- newListPrincipals :: ResourceOwner -> ListPrincipals
- data ListPrincipalsResponse = ListPrincipalsResponse' (Maybe Text) (Maybe [Principal]) Int
- newListPrincipalsResponse :: Int -> ListPrincipalsResponse
- data ListResourceSharePermissions = ListResourceSharePermissions' (Maybe Natural) (Maybe Text) Text
- newListResourceSharePermissions :: Text -> ListResourceSharePermissions
- data ListResourceSharePermissionsResponse = ListResourceSharePermissionsResponse' (Maybe Text) (Maybe [ResourceSharePermissionSummary]) Int
- newListResourceSharePermissionsResponse :: Int -> ListResourceSharePermissionsResponse
- data ListResourceTypes = ListResourceTypes' (Maybe Natural) (Maybe Text) (Maybe ResourceRegionScopeFilter)
- newListResourceTypes :: ListResourceTypes
- data ListResourceTypesResponse = ListResourceTypesResponse' (Maybe Text) (Maybe [ServiceNameAndResourceType]) Int
- newListResourceTypesResponse :: Int -> ListResourceTypesResponse
- data ListResources = ListResources' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ResourceRegionScopeFilter) (Maybe [Text]) (Maybe Text) ResourceOwner
- newListResources :: ResourceOwner -> ListResources
- data ListResourcesResponse = ListResourcesResponse' (Maybe Text) (Maybe [Resource]) Int
- newListResourcesResponse :: Int -> ListResourcesResponse
- data PromoteResourceShareCreatedFromPolicy = PromoteResourceShareCreatedFromPolicy' Text
- newPromoteResourceShareCreatedFromPolicy :: Text -> PromoteResourceShareCreatedFromPolicy
- data PromoteResourceShareCreatedFromPolicyResponse = PromoteResourceShareCreatedFromPolicyResponse' (Maybe Bool) Int
- newPromoteResourceShareCreatedFromPolicyResponse :: Int -> PromoteResourceShareCreatedFromPolicyResponse
- data RejectResourceShareInvitation = RejectResourceShareInvitation' (Maybe Text) Text
- newRejectResourceShareInvitation :: Text -> RejectResourceShareInvitation
- data RejectResourceShareInvitationResponse = RejectResourceShareInvitationResponse' (Maybe Text) (Maybe ResourceShareInvitation) Int
- newRejectResourceShareInvitationResponse :: Int -> RejectResourceShareInvitationResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateResourceShare = UpdateResourceShare' (Maybe Bool) (Maybe Text) (Maybe Text) Text
- newUpdateResourceShare :: Text -> UpdateResourceShare
- data UpdateResourceShareResponse = UpdateResourceShareResponse' (Maybe Text) (Maybe ResourceShare) Int
- newUpdateResourceShareResponse :: Int -> UpdateResourceShareResponse
- newtype ResourceOwner where
- ResourceOwner' { }
- pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner
- pattern ResourceOwner_SELF :: ResourceOwner
- newtype ResourceRegionScope where
- newtype ResourceRegionScopeFilter where
- newtype ResourceShareAssociationStatus where
- ResourceShareAssociationStatus' { }
- pattern ResourceShareAssociationStatus_ASSOCIATED :: ResourceShareAssociationStatus
- pattern ResourceShareAssociationStatus_ASSOCIATING :: ResourceShareAssociationStatus
- pattern ResourceShareAssociationStatus_DISASSOCIATED :: ResourceShareAssociationStatus
- pattern ResourceShareAssociationStatus_DISASSOCIATING :: ResourceShareAssociationStatus
- pattern ResourceShareAssociationStatus_FAILED :: ResourceShareAssociationStatus
- newtype ResourceShareAssociationType where
- newtype ResourceShareFeatureSet where
- newtype ResourceShareInvitationStatus where
- ResourceShareInvitationStatus' { }
- pattern ResourceShareInvitationStatus_ACCEPTED :: ResourceShareInvitationStatus
- pattern ResourceShareInvitationStatus_EXPIRED :: ResourceShareInvitationStatus
- pattern ResourceShareInvitationStatus_PENDING :: ResourceShareInvitationStatus
- pattern ResourceShareInvitationStatus_REJECTED :: ResourceShareInvitationStatus
- newtype ResourceShareStatus where
- ResourceShareStatus' { }
- pattern ResourceShareStatus_ACTIVE :: ResourceShareStatus
- pattern ResourceShareStatus_DELETED :: ResourceShareStatus
- pattern ResourceShareStatus_DELETING :: ResourceShareStatus
- pattern ResourceShareStatus_FAILED :: ResourceShareStatus
- pattern ResourceShareStatus_PENDING :: ResourceShareStatus
- newtype ResourceStatus where
- ResourceStatus' { }
- pattern ResourceStatus_AVAILABLE :: ResourceStatus
- pattern ResourceStatus_LIMIT_EXCEEDED :: ResourceStatus
- pattern ResourceStatus_PENDING :: ResourceStatus
- pattern ResourceStatus_UNAVAILABLE :: ResourceStatus
- pattern ResourceStatus_ZONAL_RESOURCE_INACCESSIBLE :: ResourceStatus
- data Principal = Principal' (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newPrincipal :: Principal
- data Resource = Resource' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ResourceRegionScope) (Maybe Text) (Maybe ResourceStatus) (Maybe Text) (Maybe Text)
- newResource :: Resource
- data ResourceShare = ResourceShare' (Maybe Bool) (Maybe POSIX) (Maybe ResourceShareFeatureSet) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResourceShareStatus) (Maybe Text) (Maybe [Tag])
- newResourceShare :: ResourceShare
- data ResourceShareAssociation = ResourceShareAssociation' (Maybe Text) (Maybe ResourceShareAssociationType) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ResourceShareAssociationStatus) (Maybe Text)
- newResourceShareAssociation :: ResourceShareAssociation
- data ResourceShareInvitation = ResourceShareInvitation' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ResourceShareAssociation]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResourceShareInvitationStatus)
- newResourceShareInvitation :: ResourceShareInvitation
- data ResourceSharePermissionDetail = ResourceSharePermissionDetail' (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newResourceSharePermissionDetail :: ResourceSharePermissionDetail
- data ResourceSharePermissionSummary = ResourceSharePermissionSummary' (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newResourceSharePermissionSummary :: ResourceSharePermissionSummary
- data ServiceNameAndResourceType = ServiceNameAndResourceType' (Maybe ResourceRegionScope) (Maybe Text) (Maybe Text)
- newServiceNameAndResourceType :: ServiceNameAndResourceType
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data TagFilter = TagFilter' (Maybe Text) (Maybe [Text])
- newTagFilter :: TagFilter
Service Configuration
defaultService :: Service Source #
API version 2018-01-04
of the Amazon Resource Access Manager SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by RAM
.
IdempotentParameterMismatchException
_IdempotentParameterMismatchException :: AsError a => Fold a ServiceError Source #
The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.
InvalidClientTokenException
_InvalidClientTokenException :: AsError a => Fold a ServiceError Source #
The client token is not valid.
InvalidMaxResultsException
_InvalidMaxResultsException :: AsError a => Fold a ServiceError Source #
The specified value for MaxResults
is not valid.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The specified value for NextToken
is not valid.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
A parameter is not valid.
InvalidResourceTypeException
_InvalidResourceTypeException :: AsError a => Fold a ServiceError Source #
The specified resource type is not valid.
InvalidStateTransitionException
_InvalidStateTransitionException :: AsError a => Fold a ServiceError Source #
The requested state transition is not valid.
MalformedArnException
_MalformedArnException :: AsError a => Fold a ServiceError Source #
The format of an Amazon Resource Name (ARN) is not valid.
MissingRequiredParameterException
_MissingRequiredParameterException :: AsError a => Fold a ServiceError Source #
A required input parameter is missing.
OperationNotPermittedException
_OperationNotPermittedException :: AsError a => Fold a ServiceError Source #
The requested operation is not permitted.
ResourceArnNotFoundException
_ResourceArnNotFoundException :: AsError a => Fold a ServiceError Source #
The specified Amazon Resource Name (ARN) was not found.
ResourceShareInvitationAlreadyAcceptedException
_ResourceShareInvitationAlreadyAcceptedException :: AsError a => Fold a ServiceError Source #
The specified invitation was already accepted.
ResourceShareInvitationAlreadyRejectedException
_ResourceShareInvitationAlreadyRejectedException :: AsError a => Fold a ServiceError Source #
The specified invitation was already rejected.
ResourceShareInvitationArnNotFoundException
_ResourceShareInvitationArnNotFoundException :: AsError a => Fold a ServiceError Source #
The specified Amazon Resource Name (ARN) for an invitation was not found.
ResourceShareInvitationExpiredException
_ResourceShareInvitationExpiredException :: AsError a => Fold a ServiceError Source #
The specified invitation is expired.
ResourceShareLimitExceededException
_ResourceShareLimitExceededException :: AsError a => Fold a ServiceError Source #
This request would exceed the limit for resource shares for your account.
ServerInternalException
_ServerInternalException :: AsError a => Fold a ServiceError Source #
The service could not respond to the request due to an internal problem.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is not available.
TagLimitExceededException
_TagLimitExceededException :: AsError a => Fold a ServiceError Source #
This request would exceed the limit for tags for your account.
TagPolicyViolationException
_TagPolicyViolationException :: AsError a => Fold a ServiceError Source #
The specified tag key is a reserved word and can't be used.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
You exceeded the rate at which you are allowed to perform this operation. Please try again later.
UnknownResourceException
_UnknownResourceException :: AsError a => Fold a ServiceError Source #
A specified resource was not found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AcceptResourceShareInvitation
data AcceptResourceShareInvitation Source #
See: newAcceptResourceShareInvitation
smart constructor.
Instances
newAcceptResourceShareInvitation Source #
Create a value of AcceptResourceShareInvitation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AcceptResourceShareInvitation
, acceptResourceShareInvitation_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
AcceptResourceShareInvitation
, acceptResourceShareInvitation_resourceShareInvitationArn
- The
Amazon Resoure Name (ARN)
of the invitation that you want to accept.
data AcceptResourceShareInvitationResponse Source #
See: newAcceptResourceShareInvitationResponse
smart constructor.
Instances
newAcceptResourceShareInvitationResponse Source #
Create a value of AcceptResourceShareInvitationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AcceptResourceShareInvitation
, acceptResourceShareInvitationResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
$sel:resourceShareInvitation:AcceptResourceShareInvitationResponse'
, acceptResourceShareInvitationResponse_resourceShareInvitation
- An object that contains information about the specified invitation.
$sel:httpStatus:AcceptResourceShareInvitationResponse'
, acceptResourceShareInvitationResponse_httpStatus
- The response's http status code.
AssociateResourceShare
newAssociateResourceShare Source #
Create a value of AssociateResourceShare
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateResourceShare
, associateResourceShare_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
$sel:principals:AssociateResourceShare'
, associateResourceShare_principals
- Specifies a list of principals to whom you want to the resource share.
This can be null
if you want to add only resources.
What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.
You can include the following values:
- An Amazon Web Services account ID, for example:
123456789012
- An
Amazon Resoure Name (ARN)
of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
- An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
- An ARN of an IAM role, for example:
iam::123456789012:role/rolename
- An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
$sel:resourceArns:AssociateResourceShare'
, associateResourceShare_resourceArns
- Specifies a list of
Amazon Resource Names (ARNs)
of the resources that you want to share. This can be null
if you want
to add only principals.
AssociateResourceShare
, associateResourceShare_resourceShareArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource share that you want to add principals or resources to.
data AssociateResourceShareResponse Source #
See: newAssociateResourceShareResponse
smart constructor.
Instances
newAssociateResourceShareResponse Source #
Create a value of AssociateResourceShareResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateResourceShare
, associateResourceShareResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
AssociateResourceShareResponse
, associateResourceShareResponse_resourceShareAssociations
- An array of objects that contain information about the associations.
$sel:httpStatus:AssociateResourceShareResponse'
, associateResourceShareResponse_httpStatus
- The response's http status code.
AssociateResourceSharePermission
data AssociateResourceSharePermission Source #
See: newAssociateResourceSharePermission
smart constructor.
Instances
newAssociateResourceSharePermission Source #
Create a value of AssociateResourceSharePermission
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateResourceSharePermission
, associateResourceSharePermission_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
$sel:permissionVersion:AssociateResourceSharePermission'
, associateResourceSharePermission_permissionVersion
- Specifies the version of the RAM permission to associate with the
resource share. If you don't specify this parameter, the operation uses
the version designated as the default. You can use the
ListPermissionVersions operation to discover the available versions of a
permission.
$sel:replace:AssociateResourceSharePermission'
, associateResourceSharePermission_replace
- Specifies whether the specified permission should replace or add to the
existing permission associated with the resource share. Use true
to
replace the current permissions. Use false
to add the permission to
the current permission. The default value is false
.
A resource share can have only one permission per resource type. If a
resource share already has a permission for the specified resource type
and you don't set replace
to true
then the operation returns an
error. This helps prevent accidental overwriting of a permission.
AssociateResourceSharePermission
, associateResourceSharePermission_resourceShareArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource share to which you want to add or replace permissions.
$sel:permissionArn:AssociateResourceSharePermission'
, associateResourceSharePermission_permissionArn
- Specifies the
Amazon Resoure Name (ARN)
of the RAM permission to associate with the resource share. To find the
ARN for a permission, use either the ListPermissions operation or go to
the
Permissions library
page in the RAM console and then choose the name of the permission. The
ARN is displayed on the detail page.
data AssociateResourceSharePermissionResponse Source #
See: newAssociateResourceSharePermissionResponse
smart constructor.
Instances
newAssociateResourceSharePermissionResponse Source #
Create a value of AssociateResourceSharePermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateResourceSharePermission
, associateResourceSharePermissionResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
$sel:returnValue:AssociateResourceSharePermissionResponse'
, associateResourceSharePermissionResponse_returnValue
- A return value of true
indicates that the request succeeded. A value
of false
indicates that the request failed.
$sel:httpStatus:AssociateResourceSharePermissionResponse'
, associateResourceSharePermissionResponse_httpStatus
- The response's http status code.
CreateResourceShare
data CreateResourceShare Source #
See: newCreateResourceShare
smart constructor.
CreateResourceShare' (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text |
Instances
newCreateResourceShare Source #
Create a value of CreateResourceShare
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateResourceShare
, createResourceShare_allowExternalPrincipals
- Specifies whether principals outside your organization in Organizations
can be associated with a resource share. A value of true
lets you
share with individual Amazon Web Services accounts that are not in
your organization. A value of false
only has meaning if your account
is a member of an Amazon Web Services Organization. The default value is
true
.
CreateResourceShare
, createResourceShare_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
$sel:permissionArns:CreateResourceShare'
, createResourceShare_permissionArns
- Specifies the
Amazon Resource Names (ARNs)
of the RAM permission to associate with the resource share. If you do
not specify an ARN for the permission, RAM automatically attaches the
default version of the permission for each resource type. You can
associate only one permission with each resource type included in the
resource share.
$sel:principals:CreateResourceShare'
, createResourceShare_principals
- Specifies a list of one or more principals to associate with the
resource share.
You can include the following values:
- An Amazon Web Services account ID, for example:
123456789012
- An
Amazon Resoure Name (ARN)
of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
- An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
- An ARN of an IAM role, for example:
iam::123456789012:role/rolename
- An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
$sel:resourceArns:CreateResourceShare'
, createResourceShare_resourceArns
- Specifies a list of one or more ARNs of the resources to associate with
the resource share.
CreateResourceShare
, createResourceShare_tags
- Specifies one or more tags to attach to the resource share itself. It
doesn't attach the tags to the resources associated with the resource
share.
CreateResourceShare
, createResourceShare_name
- Specifies the name of the resource share.
data CreateResourceShareResponse Source #
See: newCreateResourceShareResponse
smart constructor.
Instances
newCreateResourceShareResponse Source #
Create a value of CreateResourceShareResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateResourceShare
, createResourceShareResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
$sel:resourceShare:CreateResourceShareResponse'
, createResourceShareResponse_resourceShare
- An object with information about the new resource share.
$sel:httpStatus:CreateResourceShareResponse'
, createResourceShareResponse_httpStatus
- The response's http status code.
DeleteResourceShare
newDeleteResourceShare Source #
Create a value of DeleteResourceShare
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResourceShare
, deleteResourceShare_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
DeleteResourceShare
, deleteResourceShare_resourceShareArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource share to delete.
data DeleteResourceShareResponse Source #
See: newDeleteResourceShareResponse
smart constructor.
Instances
newDeleteResourceShareResponse Source #
Create a value of DeleteResourceShareResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResourceShare
, deleteResourceShareResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
$sel:returnValue:DeleteResourceShareResponse'
, deleteResourceShareResponse_returnValue
- A return value of true
indicates that the request succeeded. A value
of false
indicates that the request failed.
$sel:httpStatus:DeleteResourceShareResponse'
, deleteResourceShareResponse_httpStatus
- The response's http status code.
DisassociateResourceShare
data DisassociateResourceShare Source #
See: newDisassociateResourceShare
smart constructor.
Instances
newDisassociateResourceShare Source #
Create a value of DisassociateResourceShare
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateResourceShare
, disassociateResourceShare_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
$sel:principals:DisassociateResourceShare'
, disassociateResourceShare_principals
- Specifies a list of one or more principals that no longer are to have
access to the resources in this resource share.
You can include the following values:
- An Amazon Web Services account ID, for example:
123456789012
- An
Amazon Resoure Name (ARN)
of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
- An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
- An ARN of an IAM role, for example:
iam::123456789012:role/rolename
- An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
$sel:resourceArns:DisassociateResourceShare'
, disassociateResourceShare_resourceArns
- Specifies a list of
Amazon Resource Names (ARNs)
for one or more resources that you want to remove from the resource
share. After the operation runs, these resources are no longer shared
with principals outside of the Amazon Web Services account that created
the resources.
DisassociateResourceShare
, disassociateResourceShare_resourceShareArn
- Specifies
Amazon Resoure Name (ARN)
of the resource share that you want to remove resources from.
data DisassociateResourceShareResponse Source #
See: newDisassociateResourceShareResponse
smart constructor.
Instances
newDisassociateResourceShareResponse Source #
Create a value of DisassociateResourceShareResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateResourceShare
, disassociateResourceShareResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
DisassociateResourceShareResponse
, disassociateResourceShareResponse_resourceShareAssociations
- An array of objects that contain information about the updated
associations for this resource share.
$sel:httpStatus:DisassociateResourceShareResponse'
, disassociateResourceShareResponse_httpStatus
- The response's http status code.
DisassociateResourceSharePermission
data DisassociateResourceSharePermission Source #
See: newDisassociateResourceSharePermission
smart constructor.
Instances
newDisassociateResourceSharePermission Source #
Create a value of DisassociateResourceSharePermission
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateResourceSharePermission
, disassociateResourceSharePermission_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
DisassociateResourceSharePermission
, disassociateResourceSharePermission_resourceShareArn
- The
Amazon Resoure Name (ARN)
of the resource share from which you want to disassociate a permission.
$sel:permissionArn:DisassociateResourceSharePermission'
, disassociateResourceSharePermission_permissionArn
- The
Amazon Resoure Name (ARN)
of the permission to disassociate from the resource share. Changes to
permissions take effect immediately.
data DisassociateResourceSharePermissionResponse Source #
See: newDisassociateResourceSharePermissionResponse
smart constructor.
Instances
newDisassociateResourceSharePermissionResponse Source #
:: Int |
|
-> DisassociateResourceSharePermissionResponse |
Create a value of DisassociateResourceSharePermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateResourceSharePermission
, disassociateResourceSharePermissionResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
$sel:returnValue:DisassociateResourceSharePermissionResponse'
, disassociateResourceSharePermissionResponse_returnValue
- A return value of true
indicates that the request succeeded. A value
of false
indicates that the request failed.
$sel:httpStatus:DisassociateResourceSharePermissionResponse'
, disassociateResourceSharePermissionResponse_httpStatus
- The response's http status code.
EnableSharingWithAwsOrganization
data EnableSharingWithAwsOrganization Source #
See: newEnableSharingWithAwsOrganization
smart constructor.
Instances
newEnableSharingWithAwsOrganization :: EnableSharingWithAwsOrganization Source #
Create a value of EnableSharingWithAwsOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data EnableSharingWithAwsOrganizationResponse Source #
See: newEnableSharingWithAwsOrganizationResponse
smart constructor.
Instances
newEnableSharingWithAwsOrganizationResponse Source #
Create a value of EnableSharingWithAwsOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:returnValue:EnableSharingWithAwsOrganizationResponse'
, enableSharingWithAwsOrganizationResponse_returnValue
- A return value of true
indicates that the request succeeded. A value
of false
indicates that the request failed.
$sel:httpStatus:EnableSharingWithAwsOrganizationResponse'
, enableSharingWithAwsOrganizationResponse_httpStatus
- The response's http status code.
GetPermission
data GetPermission Source #
See: newGetPermission
smart constructor.
Instances
Create a value of GetPermission
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:permissionVersion:GetPermission'
, getPermission_permissionVersion
- Specifies identifier for the version of the RAM permission to retrieve.
If you don't specify this parameter, the operation retrieves the
default version.
$sel:permissionArn:GetPermission'
, getPermission_permissionArn
- Specifies the
Amazon Resoure Name (ARN)
of the permission whose contents you want to retrieve. To find the ARN
for a permission, use either the ListPermissions operation or go to the
Permissions library
page in the RAM console and then choose the name of the permission. The
ARN is displayed on the detail page.
data GetPermissionResponse Source #
See: newGetPermissionResponse
smart constructor.
Instances
newGetPermissionResponse Source #
Create a value of GetPermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetPermissionResponse
, getPermissionResponse_permission
- An object that contains information about the permission.
$sel:httpStatus:GetPermissionResponse'
, getPermissionResponse_httpStatus
- The response's http status code.
GetResourcePolicies (Paginated)
data GetResourcePolicies Source #
See: newGetResourcePolicies
smart constructor.
Instances
newGetResourcePolicies :: GetResourcePolicies Source #
Create a value of GetResourcePolicies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetResourcePolicies'
, getResourcePolicies_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
GetResourcePolicies
, getResourcePolicies_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
$sel:principal:GetResourcePolicies'
, getResourcePolicies_principal
- Specifies the principal.
$sel:resourceArns:GetResourcePolicies'
, getResourcePolicies_resourceArns
- Specifies the
Amazon Resource Names (ARNs)
of the resources whose policies you want to retrieve.
data GetResourcePoliciesResponse Source #
See: newGetResourcePoliciesResponse
smart constructor.
Instances
newGetResourcePoliciesResponse Source #
Create a value of GetResourcePoliciesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResourcePolicies
, getResourcePoliciesResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:policies:GetResourcePoliciesResponse'
, getResourcePoliciesResponse_policies
- An array of resource policy documents in JSON format.
$sel:httpStatus:GetResourcePoliciesResponse'
, getResourcePoliciesResponse_httpStatus
- The response's http status code.
GetResourceShareAssociations (Paginated)
data GetResourceShareAssociations Source #
See: newGetResourceShareAssociations
smart constructor.
GetResourceShareAssociations' (Maybe ResourceShareAssociationStatus) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) ResourceShareAssociationType |
Instances
newGetResourceShareAssociations Source #
Create a value of GetResourceShareAssociations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associationStatus:GetResourceShareAssociations'
, getResourceShareAssociations_associationStatus
- Specifies that you want to retrieve only associations with this status.
$sel:maxResults:GetResourceShareAssociations'
, getResourceShareAssociations_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
GetResourceShareAssociations
, getResourceShareAssociations_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
$sel:principal:GetResourceShareAssociations'
, getResourceShareAssociations_principal
- Specifies the ID of the principal whose resource shares you want to
retrieve. This can be an Amazon Web Services account ID, an organization
ID, an organizational unit ID, or the
Amazon Resoure Name (ARN)
of an individual IAM user or role.
You cannot specify this parameter if the association type is RESOURCE
.
$sel:resourceArn:GetResourceShareAssociations'
, getResourceShareAssociations_resourceArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource whose resource shares you want to retrieve.
You cannot specify this parameter if the association type is
PRINCIPAL
.
$sel:resourceShareArns:GetResourceShareAssociations'
, getResourceShareAssociations_resourceShareArns
- Specifies a list of
Amazon Resource Names (ARNs)
of the resource share whose associations you want to retrieve.
GetResourceShareAssociations
, getResourceShareAssociations_associationType
- Specifies whether you want to retrieve the associations that involve a
specified resource or principal.
PRINCIPAL
– list the principals that are associated with the specified resource share.RESOURCE
– list the resources that are associated with the specified resource share.
data GetResourceShareAssociationsResponse Source #
See: newGetResourceShareAssociationsResponse
smart constructor.
Instances
newGetResourceShareAssociationsResponse Source #
Create a value of GetResourceShareAssociationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResourceShareAssociations
, getResourceShareAssociationsResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
GetResourceShareAssociationsResponse
, getResourceShareAssociationsResponse_resourceShareAssociations
- An array of objects that contain the details about the associations.
$sel:httpStatus:GetResourceShareAssociationsResponse'
, getResourceShareAssociationsResponse_httpStatus
- The response's http status code.
GetResourceShareInvitations (Paginated)
data GetResourceShareInvitations Source #
See: newGetResourceShareInvitations
smart constructor.
Instances
newGetResourceShareInvitations :: GetResourceShareInvitations Source #
Create a value of GetResourceShareInvitations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetResourceShareInvitations'
, getResourceShareInvitations_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
GetResourceShareInvitations
, getResourceShareInvitations_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
$sel:resourceShareArns:GetResourceShareInvitations'
, getResourceShareInvitations_resourceShareArns
- Specifies that you want details about invitations only for the resource
shares described by this list of
Amazon Resource Names (ARNs)
$sel:resourceShareInvitationArns:GetResourceShareInvitations'
, getResourceShareInvitations_resourceShareInvitationArns
- Specifies the
Amazon Resource Names (ARNs)
of the resource share invitations you want information about.
data GetResourceShareInvitationsResponse Source #
See: newGetResourceShareInvitationsResponse
smart constructor.
Instances
newGetResourceShareInvitationsResponse Source #
Create a value of GetResourceShareInvitationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResourceShareInvitations
, getResourceShareInvitationsResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:resourceShareInvitations:GetResourceShareInvitationsResponse'
, getResourceShareInvitationsResponse_resourceShareInvitations
- An array of objects that contain the details about the invitations.
$sel:httpStatus:GetResourceShareInvitationsResponse'
, getResourceShareInvitationsResponse_httpStatus
- The response's http status code.
GetResourceShares (Paginated)
data GetResourceShares Source #
See: newGetResourceShares
smart constructor.
GetResourceShares' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ResourceShareStatus) (Maybe [TagFilter]) ResourceOwner |
Instances
Create a value of GetResourceShares
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetResourceShares'
, getResourceShares_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
GetResourceShares
, getResourceShares_name
- Specifies the name of an individual resource share that you want to
retrieve details about.
GetResourceShares
, getResourceShares_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
$sel:permissionArn:GetResourceShares'
, getResourceShares_permissionArn
- Specifies that you want to retrieve details of only those resource
shares that use the RAM permission with this
Amazon Resoure Name (ARN).
$sel:resourceShareArns:GetResourceShares'
, getResourceShares_resourceShareArns
- Specifies the
Amazon Resource Names (ARNs)
of individual resource shares that you want information about.
$sel:resourceShareStatus:GetResourceShares'
, getResourceShares_resourceShareStatus
- Specifies that you want to retrieve details of only those resource
shares that have this status.
$sel:tagFilters:GetResourceShares'
, getResourceShares_tagFilters
- Specifies that you want to retrieve details of only those resource
shares that match the specified tag keys and values.
$sel:resourceOwner:GetResourceShares'
, getResourceShares_resourceOwner
- Specifies that you want to retrieve details of only those resource
shares that match the following:
SELF
– resource shares that your account shares with other accountsOTHER-ACCOUNTS
– resource shares that other accounts share with your account
data GetResourceSharesResponse Source #
See: newGetResourceSharesResponse
smart constructor.
Instances
newGetResourceSharesResponse Source #
Create a value of GetResourceSharesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetResourceShares
, getResourceSharesResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:resourceShares:GetResourceSharesResponse'
, getResourceSharesResponse_resourceShares
- An array of objects that contain the information about the resource
shares.
$sel:httpStatus:GetResourceSharesResponse'
, getResourceSharesResponse_httpStatus
- The response's http status code.
ListPendingInvitationResources
data ListPendingInvitationResources Source #
See: newListPendingInvitationResources
smart constructor.
Instances
newListPendingInvitationResources Source #
Create a value of ListPendingInvitationResources
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListPendingInvitationResources'
, listPendingInvitationResources_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
ListPendingInvitationResources
, listPendingInvitationResources_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
ListPendingInvitationResources
, listPendingInvitationResources_resourceRegionScope
- Specifies that you want the results to include only resources that have
the specified scope.
ALL
– the results include both global and regional resources or resource types.GLOBAL
– the results include only global resources or resource types.REGIONAL
– the results include only regional resources or resource types.
The default value is ALL
.
ListPendingInvitationResources
, listPendingInvitationResources_resourceShareInvitationArn
- Specifies the
Amazon Resoure Name (ARN)
of the invitation. You can use GetResourceShareInvitations to find the
ARN of the invitation.
data ListPendingInvitationResourcesResponse Source #
See: newListPendingInvitationResourcesResponse
smart constructor.
Instances
newListPendingInvitationResourcesResponse Source #
Create a value of ListPendingInvitationResourcesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPendingInvitationResources
, listPendingInvitationResourcesResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:resources:ListPendingInvitationResourcesResponse'
, listPendingInvitationResourcesResponse_resources
- An array of objects that contain the information about the resources
included the specified resource share.
$sel:httpStatus:ListPendingInvitationResourcesResponse'
, listPendingInvitationResourcesResponse_httpStatus
- The response's http status code.
ListPermissionVersions
data ListPermissionVersions Source #
See: newListPermissionVersions
smart constructor.
Instances
newListPermissionVersions Source #
Create a value of ListPermissionVersions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListPermissionVersions'
, listPermissionVersions_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
ListPermissionVersions
, listPermissionVersions_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
$sel:permissionArn:ListPermissionVersions'
, listPermissionVersions_permissionArn
- Specifies the
Amazon Resoure Name (ARN)
of the RAM permission whose versions you want to list. You can use the
permissionVersion
parameter on the AssociateResourceSharePermission
operation to specify a non-default version to attach.
data ListPermissionVersionsResponse Source #
See: newListPermissionVersionsResponse
smart constructor.
Instances
newListPermissionVersionsResponse Source #
Create a value of ListPermissionVersionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPermissionVersions
, listPermissionVersionsResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:permissions:ListPermissionVersionsResponse'
, listPermissionVersionsResponse_permissions
- An array of objects that contain details for each of the available
versions.
$sel:httpStatus:ListPermissionVersionsResponse'
, listPermissionVersionsResponse_httpStatus
- The response's http status code.
ListPermissions
data ListPermissions Source #
See: newListPermissions
smart constructor.
Instances
newListPermissions :: ListPermissions Source #
Create a value of ListPermissions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListPermissions'
, listPermissions_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
ListPermissions
, listPermissions_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
ListPermissions
, listPermissions_resourceType
- Specifies that you want to list permissions for only the specified
resource type. For example, to list only permissions that apply to EC2
subnets, specify ec2:Subnet
. You can use the ListResourceTypes
operation to get the specific string required.
data ListPermissionsResponse Source #
See: newListPermissionsResponse
smart constructor.
Instances
newListPermissionsResponse Source #
Create a value of ListPermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPermissions
, listPermissionsResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:permissions:ListPermissionsResponse'
, listPermissionsResponse_permissions
- An array of objects with information about the permissions.
$sel:httpStatus:ListPermissionsResponse'
, listPermissionsResponse_httpStatus
- The response's http status code.
ListPrincipals (Paginated)
data ListPrincipals Source #
See: newListPrincipals
smart constructor.
ListPrincipals' (Maybe Natural) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) ResourceOwner |
Instances
Create a value of ListPrincipals
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListPrincipals'
, listPrincipals_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
ListPrincipals
, listPrincipals_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
ListPrincipals
, listPrincipals_principals
- Specifies that you want to list information for only the listed
principals.
You can include the following values:
- An Amazon Web Services account ID, for example:
123456789012
- An
Amazon Resoure Name (ARN)
of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
- An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
- An ARN of an IAM role, for example:
iam::123456789012:role/rolename
- An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
$sel:resourceArn:ListPrincipals'
, listPrincipals_resourceArn
- Specifies that you want to list principal information for the resource
share with the specified
Amazon Resoure Name (ARN).
$sel:resourceShareArns:ListPrincipals'
, listPrincipals_resourceShareArns
- Specifies that you want to list information for only principals
associated with the resource shares specified by a list the
Amazon Resource Names (ARNs).
ListPrincipals
, listPrincipals_resourceType
- Specifies that you want to list information for only principals
associated with resource shares that include the specified resource
type.
For a list of valid values, query the ListResourceTypes operation.
$sel:resourceOwner:ListPrincipals'
, listPrincipals_resourceOwner
- Specifies that you want to list information for only resource shares
that match the following:
SELF
– principals that your account is sharing resources withOTHER-ACCOUNTS
– principals that are sharing resources with your account
data ListPrincipalsResponse Source #
See: newListPrincipalsResponse
smart constructor.
Instances
newListPrincipalsResponse Source #
Create a value of ListPrincipalsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPrincipals
, listPrincipalsResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
ListPrincipals
, listPrincipalsResponse_principals
- An array of objects that contain the details about the principals.
$sel:httpStatus:ListPrincipalsResponse'
, listPrincipalsResponse_httpStatus
- The response's http status code.
ListResourceSharePermissions
data ListResourceSharePermissions Source #
See: newListResourceSharePermissions
smart constructor.
Instances
newListResourceSharePermissions Source #
Create a value of ListResourceSharePermissions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResourceSharePermissions'
, listResourceSharePermissions_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
ListResourceSharePermissions
, listResourceSharePermissions_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
ListResourceSharePermissions
, listResourceSharePermissions_resourceShareArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource share for which you want to retrieve the associated
permissions.
data ListResourceSharePermissionsResponse Source #
See: newListResourceSharePermissionsResponse
smart constructor.
Instances
newListResourceSharePermissionsResponse Source #
Create a value of ListResourceSharePermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResourceSharePermissions
, listResourceSharePermissionsResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:permissions:ListResourceSharePermissionsResponse'
, listResourceSharePermissionsResponse_permissions
- An array of objects that describe the permissions associated with the
resource share.
$sel:httpStatus:ListResourceSharePermissionsResponse'
, listResourceSharePermissionsResponse_httpStatus
- The response's http status code.
ListResourceTypes
data ListResourceTypes Source #
See: newListResourceTypes
smart constructor.
Instances
newListResourceTypes :: ListResourceTypes Source #
Create a value of ListResourceTypes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResourceTypes'
, listResourceTypes_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
ListResourceTypes
, listResourceTypes_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
ListResourceTypes
, listResourceTypes_resourceRegionScope
- Specifies that you want the results to include only resources that have
the specified scope.
ALL
– the results include both global and regional resources or resource types.GLOBAL
– the results include only global resources or resource types.REGIONAL
– the results include only regional resources or resource types.
The default value is ALL
.
data ListResourceTypesResponse Source #
See: newListResourceTypesResponse
smart constructor.
Instances
newListResourceTypesResponse Source #
Create a value of ListResourceTypesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResourceTypes
, listResourceTypesResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:resourceTypes:ListResourceTypesResponse'
, listResourceTypesResponse_resourceTypes
- An array of objects that contain information about the resource types
that can be shared using RAM.
$sel:httpStatus:ListResourceTypesResponse'
, listResourceTypesResponse_httpStatus
- The response's http status code.
ListResources (Paginated)
data ListResources Source #
See: newListResources
smart constructor.
ListResources' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ResourceRegionScopeFilter) (Maybe [Text]) (Maybe Text) ResourceOwner |
Instances
Create a value of ListResources
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResources'
, listResources_maxResults
- Specifies the total number of results that you want included on each
page of the response. If you do not include this parameter, it defaults
to a value that is specific to the operation. If additional items exist
beyond the number you specify, the NextToken
response element is
returned with a value (not null). Include the specified value as the
NextToken
request parameter in the next call to the operation to get
the next part of the results. Note that the service might return fewer
results than the maximum even when there are more results available. You
should check NextToken
after every operation to ensure that you
receive all of the results.
ListResources
, listResources_nextToken
- Specifies that you want to receive the next page of results. Valid only
if you received a NextToken
response in the previous request. If you
did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken
response to
request the next page of results.
$sel:principal:ListResources'
, listResources_principal
- Specifies that you want to list only the resource shares that are
associated with the specified principal.
$sel:resourceArns:ListResources'
, listResources_resourceArns
- Specifies that you want to list only the resource shares that include
resources with the specified
Amazon Resource Names (ARNs).
ListResources
, listResources_resourceRegionScope
- Specifies that you want the results to include only resources that have
the specified scope.
ALL
– the results include both global and regional resources or resource types.GLOBAL
– the results include only global resources or resource types.REGIONAL
– the results include only regional resources or resource types.
The default value is ALL
.
$sel:resourceShareArns:ListResources'
, listResources_resourceShareArns
- Specifies that you want to list only resources in the resource shares
identified by the specified
Amazon Resource Names (ARNs).
ListResources
, listResources_resourceType
- Specifies that you want to list only the resource shares that include
resources of the specified resource type.
For valid values, query the ListResourceTypes operation.
$sel:resourceOwner:ListResources'
, listResources_resourceOwner
- Specifies that you want to list only the resource shares that match the
following:
SELF
– resources that your account shares with other accountsOTHER-ACCOUNTS
– resources that other accounts share with your account
data ListResourcesResponse Source #
See: newListResourcesResponse
smart constructor.
Instances
newListResourcesResponse Source #
Create a value of ListResourcesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResources
, listResourcesResponse_nextToken
- If present, this value indicates that more output is available than is
included in the current response. Use this value in the NextToken
request parameter in a subsequent call to the operation to get the next
part of the output. You should repeat this until the NextToken
response element comes back as null
. This indicates that this is the
last page of results.
$sel:resources:ListResourcesResponse'
, listResourcesResponse_resources
- An array of objects that contain information about the resources.
$sel:httpStatus:ListResourcesResponse'
, listResourcesResponse_httpStatus
- The response's http status code.
PromoteResourceShareCreatedFromPolicy
data PromoteResourceShareCreatedFromPolicy Source #
See: newPromoteResourceShareCreatedFromPolicy
smart constructor.
Instances
newPromoteResourceShareCreatedFromPolicy Source #
Create a value of PromoteResourceShareCreatedFromPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PromoteResourceShareCreatedFromPolicy
, promoteResourceShareCreatedFromPolicy_resourceShareArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource share to promote.
data PromoteResourceShareCreatedFromPolicyResponse Source #
See: newPromoteResourceShareCreatedFromPolicyResponse
smart constructor.
Instances
newPromoteResourceShareCreatedFromPolicyResponse Source #
:: Int |
|
-> PromoteResourceShareCreatedFromPolicyResponse |
Create a value of PromoteResourceShareCreatedFromPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:returnValue:PromoteResourceShareCreatedFromPolicyResponse'
, promoteResourceShareCreatedFromPolicyResponse_returnValue
- A return value of true
indicates that the request succeeded. A value
of false
indicates that the request failed.
$sel:httpStatus:PromoteResourceShareCreatedFromPolicyResponse'
, promoteResourceShareCreatedFromPolicyResponse_httpStatus
- The response's http status code.
RejectResourceShareInvitation
data RejectResourceShareInvitation Source #
See: newRejectResourceShareInvitation
smart constructor.
Instances
newRejectResourceShareInvitation Source #
Create a value of RejectResourceShareInvitation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RejectResourceShareInvitation
, rejectResourceShareInvitation_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
RejectResourceShareInvitation
, rejectResourceShareInvitation_resourceShareInvitationArn
- Specifies the
Amazon Resoure Name (ARN)
of the invitation that you want to reject.
data RejectResourceShareInvitationResponse Source #
See: newRejectResourceShareInvitationResponse
smart constructor.
Instances
newRejectResourceShareInvitationResponse Source #
Create a value of RejectResourceShareInvitationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RejectResourceShareInvitation
, rejectResourceShareInvitationResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
$sel:resourceShareInvitation:RejectResourceShareInvitationResponse'
, rejectResourceShareInvitationResponse_resourceShareInvitation
- An object that contains the details about the rejected invitation.
$sel:httpStatus:RejectResourceShareInvitationResponse'
, rejectResourceShareInvitationResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResource
, tagResource_resourceShareArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource share that you want to add tags to.
TagResource
, tagResource_tags
- A list of one or more tag key and value pairs. The tag key must be
present and not be an empty string. The tag value must be present but
can be an empty string.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResource
, untagResource_resourceShareArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource share that you want to remove tags from. The tags are
removed from the resource share, not the resources in the resource
share.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- Specifies a list of one or more tag keys that you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateResourceShare
newUpdateResourceShare Source #
Create a value of UpdateResourceShare
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateResourceShare
, updateResourceShare_allowExternalPrincipals
- Specifies whether principals outside your organization in Organizations
can be associated with a resource share.
UpdateResourceShare
, updateResourceShare_clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure
the idempotency of the request. This lets you safely retry the request
without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you
also pass the same value for all other parameters. We recommend that you
use a
UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
UpdateResourceShare
, updateResourceShare_name
- If specified, the new name that you want to attach to the resource
share.
UpdateResourceShare
, updateResourceShare_resourceShareArn
- Specifies the
Amazon Resoure Name (ARN)
of the resource share that you want to modify.
data UpdateResourceShareResponse Source #
See: newUpdateResourceShareResponse
smart constructor.
Instances
newUpdateResourceShareResponse Source #
Create a value of UpdateResourceShareResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateResourceShare
, updateResourceShareResponse_clientToken
- The idempotency identifier associated with this request. If you want to
repeat the same operation in an idempotent manner then you must include
this value in the clientToken
request parameter of that later call.
All other parameters must also have the same values that you used in the
first call.
$sel:resourceShare:UpdateResourceShareResponse'
, updateResourceShareResponse_resourceShare
- Information about the resource share.
$sel:httpStatus:UpdateResourceShareResponse'
, updateResourceShareResponse_httpStatus
- The response's http status code.
Types
ResourceOwner
newtype ResourceOwner Source #
pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner | |
pattern ResourceOwner_SELF :: ResourceOwner |
Instances
ResourceRegionScope
newtype ResourceRegionScope Source #
pattern ResourceRegionScope_GLOBAL :: ResourceRegionScope | |
pattern ResourceRegionScope_REGIONAL :: ResourceRegionScope |
Instances
ResourceRegionScopeFilter
newtype ResourceRegionScopeFilter Source #
Instances
ResourceShareAssociationStatus
newtype ResourceShareAssociationStatus Source #
Instances
ResourceShareAssociationType
newtype ResourceShareAssociationType Source #
pattern ResourceShareAssociationType_PRINCIPAL :: ResourceShareAssociationType | |
pattern ResourceShareAssociationType_RESOURCE :: ResourceShareAssociationType |
Instances
ResourceShareFeatureSet
newtype ResourceShareFeatureSet Source #
Instances
ResourceShareInvitationStatus
newtype ResourceShareInvitationStatus Source #
Instances
ResourceShareStatus
newtype ResourceShareStatus Source #
pattern ResourceShareStatus_ACTIVE :: ResourceShareStatus | |
pattern ResourceShareStatus_DELETED :: ResourceShareStatus | |
pattern ResourceShareStatus_DELETING :: ResourceShareStatus | |
pattern ResourceShareStatus_FAILED :: ResourceShareStatus | |
pattern ResourceShareStatus_PENDING :: ResourceShareStatus |
Instances
ResourceStatus
newtype ResourceStatus Source #
pattern ResourceStatus_AVAILABLE :: ResourceStatus | |
pattern ResourceStatus_LIMIT_EXCEEDED :: ResourceStatus | |
pattern ResourceStatus_PENDING :: ResourceStatus | |
pattern ResourceStatus_UNAVAILABLE :: ResourceStatus | |
pattern ResourceStatus_ZONAL_RESOURCE_INACCESSIBLE :: ResourceStatus |
Instances
Principal
Describes a principal for use with Resource Access Manager.
See: newPrincipal
smart constructor.
Instances
newPrincipal :: Principal Source #
Create a value of Principal
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:Principal'
, principal_creationTime
- The date and time when the principal was associated with the resource
share.
$sel:external:Principal'
, principal_external
- Indicates whether the principal belongs to the same organization in
Organizations as the Amazon Web Services account that owns the resource
share.
$sel:id:Principal'
, principal_id
- The ID of the principal.
$sel:lastUpdatedTime:Principal'
, principal_lastUpdatedTime
- The date and time when the association was last updated.
$sel:resourceShareArn:Principal'
, principal_resourceShareArn
- The
Amazon Resoure Name (ARN)
of a resource share the principal is associated with.
Resource
Describes a resource associated with a resource share in RAM.
See: newResource
smart constructor.
Resource' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ResourceRegionScope) (Maybe Text) (Maybe ResourceStatus) (Maybe Text) (Maybe Text) |
Instances
newResource :: Resource Source #
Create a value of Resource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Resource'
, resource_arn
- The
Amazon Resoure Name (ARN)
of the resource.
$sel:creationTime:Resource'
, resource_creationTime
- The date and time when the resource was associated with the resource
share.
$sel:lastUpdatedTime:Resource'
, resource_lastUpdatedTime
- The date an time when the association was last updated.
$sel:resourceGroupArn:Resource'
, resource_resourceGroupArn
- The
Amazon Resoure Name (ARN)
of the resource group. This value is available only if the resource is
part of a resource group.
$sel:resourceRegionScope:Resource'
, resource_resourceRegionScope
- Specifies the scope of visibility of this resource:
- REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.
- GLOBAL – The resource can be accessed from any Amazon Web Services Region.
$sel:resourceShareArn:Resource'
, resource_resourceShareArn
- The
Amazon Resoure Name (ARN)
of the resource share this resource is associated with.
$sel:status:Resource'
, resource_status
- The current status of the resource.
$sel:statusMessage:Resource'
, resource_statusMessage
- A message about the status of the resource.
$sel:type':Resource'
, resource_type
- The resource type. This takes the form of:
service-code
:resource-code
ResourceShare
data ResourceShare Source #
Describes a resource share in RAM.
See: newResourceShare
smart constructor.
ResourceShare' (Maybe Bool) (Maybe POSIX) (Maybe ResourceShareFeatureSet) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResourceShareStatus) (Maybe Text) (Maybe [Tag]) |
Instances
newResourceShare :: ResourceShare Source #
Create a value of ResourceShare
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowExternalPrincipals:ResourceShare'
, resourceShare_allowExternalPrincipals
- Indicates whether principals outside your organization in Organizations
can be associated with a resource share.
$sel:creationTime:ResourceShare'
, resourceShare_creationTime
- The date and time when the resource share was created.
$sel:featureSet:ResourceShare'
, resourceShare_featureSet
- Indicates how the resource share was created. Possible values include:
CREATED_FROM_POLICY
- Indicates that the resource share was created from an Identity and Access Management (IAM) resource-based permission policy attached to the resource. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.PROMOTING_TO_STANDARD
- The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy.STANDARD
- Indicates that the resource share was created in RAM using the console or APIs. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs.
$sel:lastUpdatedTime:ResourceShare'
, resourceShare_lastUpdatedTime
- The date and time when the resource share was last updated.
$sel:name:ResourceShare'
, resourceShare_name
- The name of the resource share.
$sel:owningAccountId:ResourceShare'
, resourceShare_owningAccountId
- The ID of the Amazon Web Services account that owns the resource share.
$sel:resourceShareArn:ResourceShare'
, resourceShare_resourceShareArn
- The
Amazon Resoure Name (ARN)
of the resource share
$sel:status:ResourceShare'
, resourceShare_status
- The current status of the resource share.
$sel:statusMessage:ResourceShare'
, resourceShare_statusMessage
- A message about the status of the resource share.
$sel:tags:ResourceShare'
, resourceShare_tags
- The tag key and value pairs attached to the resource share.
ResourceShareAssociation
data ResourceShareAssociation Source #
Describes an association with a resource share and either a principal or a resource.
See: newResourceShareAssociation
smart constructor.
ResourceShareAssociation' (Maybe Text) (Maybe ResourceShareAssociationType) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ResourceShareAssociationStatus) (Maybe Text) |
Instances
newResourceShareAssociation :: ResourceShareAssociation Source #
Create a value of ResourceShareAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedEntity:ResourceShareAssociation'
, resourceShareAssociation_associatedEntity
- The associated entity. This can be either of the following:
- For a resource association, this is the Amazon Resoure Name (ARN) of the resource.
For principal associations, this is one of the following:
- The ID of an Amazon Web Services account
- The Amazon Resoure Name (ARN) of an organization in Organizations
- The ARN of an organizational unit (OU) in Organizations
- The ARN of an IAM role
- The ARN of an IAM user
$sel:associationType:ResourceShareAssociation'
, resourceShareAssociation_associationType
- The type of entity included in this association.
$sel:creationTime:ResourceShareAssociation'
, resourceShareAssociation_creationTime
- The date and time when the association was created.
$sel:external:ResourceShareAssociation'
, resourceShareAssociation_external
- Indicates whether the principal belongs to the same organization in
Organizations as the Amazon Web Services account that owns the resource
share.
$sel:lastUpdatedTime:ResourceShareAssociation'
, resourceShareAssociation_lastUpdatedTime
- The date and time when the association was last updated.
$sel:resourceShareArn:ResourceShareAssociation'
, resourceShareAssociation_resourceShareArn
- The
Amazon Resoure Name (ARN)
of the resource share.
$sel:resourceShareName:ResourceShareAssociation'
, resourceShareAssociation_resourceShareName
- The name of the resource share.
$sel:status:ResourceShareAssociation'
, resourceShareAssociation_status
- The current status of the association.
$sel:statusMessage:ResourceShareAssociation'
, resourceShareAssociation_statusMessage
- A message about the status of the association.
ResourceShareInvitation
data ResourceShareInvitation Source #
Describes an invitation for an Amazon Web Services account to join a resource share.
See: newResourceShareInvitation
smart constructor.
ResourceShareInvitation' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ResourceShareAssociation]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResourceShareInvitationStatus) |
Instances
newResourceShareInvitation :: ResourceShareInvitation Source #
Create a value of ResourceShareInvitation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:invitationTimestamp:ResourceShareInvitation'
, resourceShareInvitation_invitationTimestamp
- The date and time when the invitation was sent.
$sel:receiverAccountId:ResourceShareInvitation'
, resourceShareInvitation_receiverAccountId
- The ID of the Amazon Web Services account that received the invitation.
$sel:receiverArn:ResourceShareInvitation'
, resourceShareInvitation_receiverArn
- The
Amazon Resoure Name (ARN)
of the IAM user or role that received the invitation.
ResourceShareInvitation
, resourceShareInvitation_resourceShareArn
- The
Amazon Resoure Name (ARN)
of the resource share
$sel:resourceShareAssociations:ResourceShareInvitation'
, resourceShareInvitation_resourceShareAssociations
- To view the resources associated with a pending resource share
invitation, use ListPendingInvitationResources.
$sel:resourceShareInvitationArn:ResourceShareInvitation'
, resourceShareInvitation_resourceShareInvitationArn
- The
Amazon Resoure Name (ARN)
of the invitation.
ResourceShareInvitation
, resourceShareInvitation_resourceShareName
- The name of the resource share.
$sel:senderAccountId:ResourceShareInvitation'
, resourceShareInvitation_senderAccountId
- The ID of the Amazon Web Services account that sent the invitation.
ResourceShareInvitation
, resourceShareInvitation_status
- The current status of the invitation.
ResourceSharePermissionDetail
data ResourceSharePermissionDetail Source #
Information about an RAM permission.
See: newResourceSharePermissionDetail
smart constructor.
ResourceSharePermissionDetail' (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newResourceSharePermissionDetail :: ResourceSharePermissionDetail Source #
Create a value of ResourceSharePermissionDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_arn
- The
Amazon Resoure Name (ARN)
of this RAM permission.
$sel:creationTime:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_creationTime
- The date and time when the permission was created.
$sel:defaultVersion:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_defaultVersion
- Specifies whether the version of the permission represented in this
structure is the default version for this permission.
$sel:isResourceTypeDefault:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_isResourceTypeDefault
- Specifies whether the version of the permission represented in this
structure is the default version for all resources of this resource
type.
$sel:lastUpdatedTime:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_lastUpdatedTime
- The date and time when the permission was last updated.
$sel:name:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_name
- The name of this permission.
$sel:permission:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_permission
- The permission's effect and actions in JSON format. The effect
indicates whether the specified actions are allowed or denied. The
actions
list the operations to which the principal is granted or
denied access.
$sel:resourceType:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_resourceType
- The resource type to which this permission applies.
$sel:version:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_version
- The version of the permission represented in this structure.
ResourceSharePermissionSummary
data ResourceSharePermissionSummary Source #
Information about an RAM permission that is associated with a resource share and any of its resources of a specified type.
See: newResourceSharePermissionSummary
smart constructor.
ResourceSharePermissionSummary' (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newResourceSharePermissionSummary :: ResourceSharePermissionSummary Source #
Create a value of ResourceSharePermissionSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_arn
- The
Amazon Resoure Name (ARN)
of the permission you want information about.
$sel:creationTime:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_creationTime
- The date and time when the permission was created.
$sel:defaultVersion:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_defaultVersion
- Specifies whether the version of the permission represented in this
structure is the default version for this permission.
$sel:isResourceTypeDefault:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_isResourceTypeDefault
- Specifies whether the version of the permission represented in this
structure is the default version for all resources of this resource
type.
$sel:lastUpdatedTime:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_lastUpdatedTime
- The date and time when the permission was last updated.
$sel:name:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_name
- The name of this permission.
$sel:resourceType:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_resourceType
- The type of resource to which this permission applies.
$sel:status:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_status
- The current status of the permission.
$sel:version:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_version
- The version of the permission represented in this structure.
ServiceNameAndResourceType
data ServiceNameAndResourceType Source #
Information about a shareable resource type and the Amazon Web Services service to which resources of that type belong.
See: newServiceNameAndResourceType
smart constructor.
Instances
newServiceNameAndResourceType :: ServiceNameAndResourceType Source #
Create a value of ServiceNameAndResourceType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceRegionScope:ServiceNameAndResourceType'
, serviceNameAndResourceType_resourceRegionScope
- Specifies the scope of visibility of resources of this type:
- REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.
- GLOBAL – The resource can be accessed from any Amazon Web Services Region.
$sel:resourceType:ServiceNameAndResourceType'
, serviceNameAndResourceType_resourceType
- The type of the resource.
$sel:serviceName:ServiceNameAndResourceType'
, serviceNameAndResourceType_serviceName
- The name of the Amazon Web Services service to which resources of this
type belong.
Tag
A structure containing a tag. A tag is metadata that you can attach to your resources to help organize and categorize them. You can also use them to help you secure your resources. For more information, see Controlling access to Amazon Web Services resources using tags.
For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.RAM.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.RAM.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.RAM.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.RAM.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.RAM.Types.Tag" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- The key, or name, attached to the tag. Every tag must have a key. Key
names are case sensitive.
$sel:value:Tag'
, tag_value
- The string value attached to the tag. The value can be an empty string.
Key values are case sensitive.
TagFilter
A tag key and optional list of possible values that you can use to filter results for tagged resources.
See: newTagFilter
smart constructor.
TagFilter' (Maybe Text) (Maybe [Text]) |
Instances
ToJSON TagFilter Source # | |
Defined in Amazonka.RAM.Types.TagFilter | |
Generic TagFilter Source # | |
Read TagFilter Source # | |
Show TagFilter Source # | |
NFData TagFilter Source # | |
Defined in Amazonka.RAM.Types.TagFilter | |
Eq TagFilter Source # | |
Hashable TagFilter Source # | |
Defined in Amazonka.RAM.Types.TagFilter | |
type Rep TagFilter Source # | |
Defined in Amazonka.RAM.Types.TagFilter type Rep TagFilter = D1 ('MetaData "TagFilter" "Amazonka.RAM.Types.TagFilter" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "TagFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) |
newTagFilter :: TagFilter Source #
Create a value of TagFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tagKey:TagFilter'
, tagFilter_tagKey
- The tag key. This must have a valid string value and can't be empty.
$sel:tagValues:TagFilter'
, tagFilter_tagValues
- A list of zero or more tag values. If no values are provided, then the
filter matches any tag with the specified key, regardless of its value.