Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- InvalidClientTokenException
- TagPolicyViolationException
- InvalidParameterException
- InvalidResourceTypeException
- ResourceShareInvitationArnNotFoundException
- InvalidNextTokenException
- MalformedArnException
- ServerInternalException
- UnknownResourceException
- OperationNotPermittedException
- InvalidMaxResultsException
- ServiceUnavailableException
- ResourceArnNotFoundException
- IdempotentParameterMismatchException
- MissingRequiredParameterException
- TagLimitExceededException
- InvalidStateTransitionException
- ResourceShareInvitationAlreadyAcceptedException
- ResourceShareLimitExceededException
- ResourceShareInvitationExpiredException
- ResourceShareInvitationAlreadyRejectedException
- Waiters
- Operations
- PromoteResourceShareCreatedFromPolicy
- GetResourceShares (Paginated)
- GetResourcePolicies (Paginated)
- ListPendingInvitationResources
- GetPermission
- EnableSharingWithAwsOrganization
- AssociateResourceSharePermission
- CreateResourceShare
- ListPrincipals (Paginated)
- ListResources (Paginated)
- AcceptResourceShareInvitation
- DeleteResourceShare
- UpdateResourceShare
- RejectResourceShareInvitation
- ListPermissions
- DisassociateResourceShare
- ListResourceSharePermissions
- TagResource
- ListResourceTypes
- GetResourceShareAssociations (Paginated)
- GetResourceShareInvitations (Paginated)
- UntagResource
- AssociateResourceShare
- DisassociateResourceSharePermission
- Types
- ResourceOwner
- 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 and within your organization or organizational units (OUs) in Organizations. For supported resource types, you can also share resources with IAM roles and IAM users. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts.
To learn more about RAM, see the following resources:
Synopsis
- defaultService :: Service
- _InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagPolicyViolationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidResourceTypeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceShareInvitationArnNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _MalformedArnException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServerInternalException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnknownResourceException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidMaxResultsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceArnNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _IdempotentParameterMismatchException :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingRequiredParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStateTransitionException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceShareInvitationAlreadyAcceptedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceShareLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceShareInvitationExpiredException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceShareInvitationAlreadyRejectedException :: AsError a => Getting (First ServiceError) a ServiceError
- data PromoteResourceShareCreatedFromPolicy = PromoteResourceShareCreatedFromPolicy' Text
- newPromoteResourceShareCreatedFromPolicy :: Text -> PromoteResourceShareCreatedFromPolicy
- data PromoteResourceShareCreatedFromPolicyResponse = PromoteResourceShareCreatedFromPolicyResponse' (Maybe Bool) Int
- newPromoteResourceShareCreatedFromPolicyResponse :: Int -> PromoteResourceShareCreatedFromPolicyResponse
- data GetResourceShares = GetResourceShares' (Maybe [TagFilter]) (Maybe Text) (Maybe Text) (Maybe ResourceShareStatus) (Maybe Text) (Maybe Natural) (Maybe [Text]) ResourceOwner
- newGetResourceShares :: ResourceOwner -> GetResourceShares
- data GetResourceSharesResponse = GetResourceSharesResponse' (Maybe [ResourceShare]) (Maybe Text) Int
- newGetResourceSharesResponse :: Int -> GetResourceSharesResponse
- data GetResourcePolicies = GetResourcePolicies' (Maybe Text) (Maybe Text) (Maybe Natural) [Text]
- newGetResourcePolicies :: GetResourcePolicies
- data GetResourcePoliciesResponse = GetResourcePoliciesResponse' (Maybe Text) (Maybe [Text]) Int
- newGetResourcePoliciesResponse :: Int -> GetResourcePoliciesResponse
- data ListPendingInvitationResources = ListPendingInvitationResources' (Maybe Text) (Maybe Natural) Text
- newListPendingInvitationResources :: Text -> ListPendingInvitationResources
- data ListPendingInvitationResourcesResponse = ListPendingInvitationResourcesResponse' (Maybe [Resource]) (Maybe Text) Int
- newListPendingInvitationResourcesResponse :: Int -> ListPendingInvitationResourcesResponse
- data GetPermission = GetPermission' (Maybe Int) Text
- newGetPermission :: Text -> GetPermission
- data GetPermissionResponse = GetPermissionResponse' (Maybe ResourceSharePermissionDetail) Int
- newGetPermissionResponse :: Int -> GetPermissionResponse
- data EnableSharingWithAwsOrganization = EnableSharingWithAwsOrganization' {
- newEnableSharingWithAwsOrganization :: EnableSharingWithAwsOrganization
- data EnableSharingWithAwsOrganizationResponse = EnableSharingWithAwsOrganizationResponse' (Maybe Bool) Int
- newEnableSharingWithAwsOrganizationResponse :: Int -> EnableSharingWithAwsOrganizationResponse
- data AssociateResourceSharePermission = AssociateResourceSharePermission' (Maybe Bool) (Maybe Text) (Maybe Int) Text Text
- newAssociateResourceSharePermission :: Text -> Text -> AssociateResourceSharePermission
- data AssociateResourceSharePermissionResponse = AssociateResourceSharePermissionResponse' (Maybe Text) (Maybe Bool) Int
- newAssociateResourceSharePermissionResponse :: Int -> AssociateResourceSharePermissionResponse
- data CreateResourceShare = CreateResourceShare' (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text
- newCreateResourceShare :: Text -> CreateResourceShare
- data CreateResourceShareResponse = CreateResourceShareResponse' (Maybe Text) (Maybe ResourceShare) Int
- newCreateResourceShareResponse :: Int -> CreateResourceShareResponse
- data ListPrincipals = ListPrincipals' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe [Text]) ResourceOwner
- newListPrincipals :: ResourceOwner -> ListPrincipals
- data ListPrincipalsResponse = ListPrincipalsResponse' (Maybe [Principal]) (Maybe Text) Int
- newListPrincipalsResponse :: Int -> ListPrincipalsResponse
- data ListResources = ListResources' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Natural) (Maybe [Text]) ResourceOwner
- newListResources :: ResourceOwner -> ListResources
- data ListResourcesResponse = ListResourcesResponse' (Maybe [Resource]) (Maybe Text) Int
- newListResourcesResponse :: Int -> ListResourcesResponse
- data AcceptResourceShareInvitation = AcceptResourceShareInvitation' (Maybe Text) Text
- newAcceptResourceShareInvitation :: Text -> AcceptResourceShareInvitation
- data AcceptResourceShareInvitationResponse = AcceptResourceShareInvitationResponse' (Maybe Text) (Maybe ResourceShareInvitation) Int
- newAcceptResourceShareInvitationResponse :: Int -> AcceptResourceShareInvitationResponse
- data DeleteResourceShare = DeleteResourceShare' (Maybe Text) Text
- newDeleteResourceShare :: Text -> DeleteResourceShare
- data DeleteResourceShareResponse = DeleteResourceShareResponse' (Maybe Text) (Maybe Bool) Int
- newDeleteResourceShareResponse :: Int -> DeleteResourceShareResponse
- data UpdateResourceShare = UpdateResourceShare' (Maybe Text) (Maybe Bool) (Maybe Text) Text
- newUpdateResourceShare :: Text -> UpdateResourceShare
- data UpdateResourceShareResponse = UpdateResourceShareResponse' (Maybe Text) (Maybe ResourceShare) Int
- newUpdateResourceShareResponse :: Int -> UpdateResourceShareResponse
- data RejectResourceShareInvitation = RejectResourceShareInvitation' (Maybe Text) Text
- newRejectResourceShareInvitation :: Text -> RejectResourceShareInvitation
- data RejectResourceShareInvitationResponse = RejectResourceShareInvitationResponse' (Maybe Text) (Maybe ResourceShareInvitation) Int
- newRejectResourceShareInvitationResponse :: Int -> RejectResourceShareInvitationResponse
- data ListPermissions = ListPermissions' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListPermissions :: ListPermissions
- data ListPermissionsResponse = ListPermissionsResponse' (Maybe Text) (Maybe [ResourceSharePermissionSummary]) Int
- newListPermissionsResponse :: Int -> ListPermissionsResponse
- 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 ListResourceSharePermissions = ListResourceSharePermissions' (Maybe Text) (Maybe Natural) Text
- newListResourceSharePermissions :: Text -> ListResourceSharePermissions
- data ListResourceSharePermissionsResponse = ListResourceSharePermissionsResponse' (Maybe Text) (Maybe [ResourceSharePermissionSummary]) Int
- newListResourceSharePermissionsResponse :: Int -> ListResourceSharePermissionsResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data ListResourceTypes = ListResourceTypes' (Maybe Text) (Maybe Natural)
- newListResourceTypes :: ListResourceTypes
- data ListResourceTypesResponse = ListResourceTypesResponse' (Maybe Text) (Maybe [ServiceNameAndResourceType]) Int
- newListResourceTypesResponse :: Int -> ListResourceTypesResponse
- data GetResourceShareAssociations = GetResourceShareAssociations' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResourceShareAssociationStatus) (Maybe Natural) (Maybe [Text]) ResourceShareAssociationType
- newGetResourceShareAssociations :: ResourceShareAssociationType -> GetResourceShareAssociations
- data GetResourceShareAssociationsResponse = GetResourceShareAssociationsResponse' (Maybe [ResourceShareAssociation]) (Maybe Text) Int
- newGetResourceShareAssociationsResponse :: Int -> GetResourceShareAssociationsResponse
- data GetResourceShareInvitations = GetResourceShareInvitations' (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe [Text])
- newGetResourceShareInvitations :: GetResourceShareInvitations
- data GetResourceShareInvitationsResponse = GetResourceShareInvitationsResponse' (Maybe [ResourceShareInvitation]) (Maybe Text) Int
- newGetResourceShareInvitationsResponse :: Int -> GetResourceShareInvitationsResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- 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 DisassociateResourceSharePermission = DisassociateResourceSharePermission' (Maybe Text) Text Text
- newDisassociateResourceSharePermission :: Text -> Text -> DisassociateResourceSharePermission
- data DisassociateResourceSharePermissionResponse = DisassociateResourceSharePermissionResponse' (Maybe Text) (Maybe Bool) Int
- newDisassociateResourceSharePermissionResponse :: Int -> DisassociateResourceSharePermissionResponse
- newtype ResourceOwner where
- ResourceOwner' { }
- pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner
- pattern ResourceOwner_SELF :: ResourceOwner
- 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 Text) (Maybe POSIX) (Maybe Bool) (Maybe Text)
- newPrincipal :: Principal
- data Resource = Resource' (Maybe POSIX) (Maybe ResourceStatus) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newResource :: Resource
- data ResourceShare = ResourceShare' (Maybe POSIX) (Maybe ResourceShareStatus) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ResourceShareFeatureSet) (Maybe [Tag])
- newResourceShare :: ResourceShare
- data ResourceShareAssociation = ResourceShareAssociation' (Maybe POSIX) (Maybe ResourceShareAssociationStatus) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ResourceShareAssociationType) (Maybe Text)
- newResourceShareAssociation :: ResourceShareAssociation
- data ResourceShareInvitation = ResourceShareInvitation' (Maybe ResourceShareInvitationStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ResourceShareAssociation]) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newResourceShareInvitation :: ResourceShareInvitation
- data ResourceSharePermissionDetail = ResourceSharePermissionDetail' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text)
- newResourceSharePermissionDetail :: ResourceSharePermissionDetail
- data ResourceSharePermissionSummary = ResourceSharePermissionSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool)
- newResourceSharePermissionSummary :: ResourceSharePermissionSummary
- data ServiceNameAndResourceType = ServiceNameAndResourceType' (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
.
InvalidClientTokenException
_InvalidClientTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A client token is not valid.
TagPolicyViolationException
_TagPolicyViolationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified tag is a reserved word and cannot be used.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A parameter is not valid.
InvalidResourceTypeException
_InvalidResourceTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource type is not valid.
ResourceShareInvitationArnNotFoundException
_ResourceShareInvitationArnNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Amazon Resource Name (ARN) for an invitation was not found.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified value for NextToken is not valid.
MalformedArnException
_MalformedArnException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The format of an Amazon Resource Name (ARN) is not valid.
ServerInternalException
_ServerInternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service could not respond to the request due to an internal problem.
UnknownResourceException
_UnknownResourceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A specified resource was not found.
OperationNotPermittedException
_OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation is not permitted.
InvalidMaxResultsException
_InvalidMaxResultsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified value for MaxResults is not valid.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service is not available.
ResourceArnNotFoundException
_ResourceArnNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An Amazon Resource Name (ARN) was not found.
IdempotentParameterMismatchException
_IdempotentParameterMismatchException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.
MissingRequiredParameterException
_MissingRequiredParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A required input parameter is missing.
TagLimitExceededException
_TagLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested tags exceed the limit for your account.
InvalidStateTransitionException
_InvalidStateTransitionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested state transition is not valid.
ResourceShareInvitationAlreadyAcceptedException
_ResourceShareInvitationAlreadyAcceptedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The invitation was already accepted.
ResourceShareLimitExceededException
_ResourceShareLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource share exceeds the limit for your account.
ResourceShareInvitationExpiredException
_ResourceShareInvitationExpiredException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The invitation is expired.
ResourceShareInvitationAlreadyRejectedException
_ResourceShareInvitationAlreadyRejectedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The invitation was already rejected.
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.
PromoteResourceShareCreatedFromPolicy
data PromoteResourceShareCreatedFromPolicy Source #
See: newPromoteResourceShareCreatedFromPolicy
smart constructor.
Instances
newPromoteResourceShareCreatedFromPolicy Source #
:: Text |
|
-> PromoteResourceShareCreatedFromPolicy |
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:
$sel:resourceShareArn:PromoteResourceShareCreatedFromPolicy'
, promoteResourceShareCreatedFromPolicy_resourceShareArn
- The Amazon Resource 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
- Indicates whether the request succeeded.
$sel:httpStatus:PromoteResourceShareCreatedFromPolicyResponse'
, promoteResourceShareCreatedFromPolicyResponse_httpStatus
- The response's http status code.
GetResourceShares (Paginated)
data GetResourceShares Source #
See: newGetResourceShares
smart constructor.
GetResourceShares' (Maybe [TagFilter]) (Maybe Text) (Maybe Text) (Maybe ResourceShareStatus) (Maybe Text) (Maybe Natural) (Maybe [Text]) 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:tagFilters:GetResourceShares'
, getResourceShares_tagFilters
- One or more tag filters.
$sel:nextToken:GetResourceShares'
, getResourceShares_nextToken
- The token for the next page of results.
$sel:name:GetResourceShares'
, getResourceShares_name
- The name of the resource share.
$sel:resourceShareStatus:GetResourceShares'
, getResourceShares_resourceShareStatus
- The status of the resource share.
$sel:permissionArn:GetResourceShares'
, getResourceShares_permissionArn
- The Amazon Resource Name (ARN) of the RAM permission that is associated
with the resource share.
$sel:maxResults:GetResourceShares'
, getResourceShares_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:resourceShareArns:GetResourceShares'
, getResourceShares_resourceShareArns
- The Amazon Resource Names (ARNs) of the resource shares.
$sel:resourceOwner:GetResourceShares'
, getResourceShares_resourceOwner
- The type of owner.
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:
$sel:resourceShares:GetResourceSharesResponse'
, getResourceSharesResponse_resourceShares
- Information about the resource shares.
$sel:nextToken:GetResourceShares'
, getResourceSharesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:GetResourceSharesResponse'
, getResourceSharesResponse_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:nextToken:GetResourcePolicies'
, getResourcePolicies_nextToken
- The token for the next page of results.
$sel:principal:GetResourcePolicies'
, getResourcePolicies_principal
- The principal.
$sel:maxResults:GetResourcePolicies'
, getResourcePolicies_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:resourceArns:GetResourcePolicies'
, getResourcePolicies_resourceArns
- The Amazon Resource Names (ARNs) of the resources.
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:
$sel:nextToken:GetResourcePolicies'
, getResourcePoliciesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:policies:GetResourcePoliciesResponse'
, getResourcePoliciesResponse_policies
- A key policy document, in JSON format.
$sel:httpStatus:GetResourcePoliciesResponse'
, getResourcePoliciesResponse_httpStatus
- The response's http status code.
ListPendingInvitationResources
data ListPendingInvitationResources Source #
See: newListPendingInvitationResources
smart constructor.
Instances
newListPendingInvitationResources Source #
:: Text |
|
-> ListPendingInvitationResources |
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:nextToken:ListPendingInvitationResources'
, listPendingInvitationResources_nextToken
- The token for the next page of results.
$sel:maxResults:ListPendingInvitationResources'
, listPendingInvitationResources_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:resourceShareInvitationArn:ListPendingInvitationResources'
, listPendingInvitationResources_resourceShareInvitationArn
- The Amazon Resource Name (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:
$sel:resources:ListPendingInvitationResourcesResponse'
, listPendingInvitationResourcesResponse_resources
- Information about the resources included the resource share.
$sel:nextToken:ListPendingInvitationResources'
, listPendingInvitationResourcesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:ListPendingInvitationResourcesResponse'
, listPendingInvitationResourcesResponse_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
- The identifier for the version of the permission.
$sel:permissionArn:GetPermission'
, getPermission_permissionArn
- The Amazon Resource Name (ARN) of the permission.
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:
$sel:permission:GetPermissionResponse'
, getPermissionResponse_permission
- Information about the permission.
$sel:httpStatus:GetPermissionResponse'
, getPermissionResponse_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
- Indicates whether the request succeeded.
$sel:httpStatus:EnableSharingWithAwsOrganizationResponse'
, enableSharingWithAwsOrganizationResponse_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:
$sel:replace:AssociateResourceSharePermission'
, associateResourceSharePermission_replace
- Indicates whether the permission should replace the permissions that are
currently associated with the resource share. Use true
to replace the
current permissions. Use false
to add the permission to the current
permission.
$sel:clientToken:AssociateResourceSharePermission'
, associateResourceSharePermission_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:permissionVersion:AssociateResourceSharePermission'
, associateResourceSharePermission_permissionVersion
- The version of the RAM permissions to associate with the resource share.
$sel:resourceShareArn:AssociateResourceSharePermission'
, associateResourceSharePermission_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:permissionArn:AssociateResourceSharePermission'
, associateResourceSharePermission_permissionArn
- The Amazon Resource Name (ARN) of the RAM permission to associate with
the resource share.
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:
$sel:clientToken:AssociateResourceSharePermission'
, associateResourceSharePermissionResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:returnValue:AssociateResourceSharePermissionResponse'
, associateResourceSharePermissionResponse_returnValue
- Indicates whether the request succeeded.
$sel:httpStatus:AssociateResourceSharePermissionResponse'
, associateResourceSharePermissionResponse_httpStatus
- The response's http status code.
CreateResourceShare
data CreateResourceShare Source #
See: newCreateResourceShare
smart constructor.
CreateResourceShare' (Maybe Text) (Maybe Bool) (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:
$sel:clientToken:CreateResourceShare'
, createResourceShare_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:allowExternalPrincipals:CreateResourceShare'
, createResourceShare_allowExternalPrincipals
- Indicates whether principals outside your organization in Organizations
can be associated with a resource share.
$sel:principals:CreateResourceShare'
, createResourceShare_principals
- The principals to associate with the resource share. The possible values
are:
- An Amazon Web Services account ID
- An Amazon Resource Name (ARN) of an organization in Organizations
- An ARN of an organizational unit (OU) in Organizations
- An ARN of an IAM role
- An ARN of an IAM user
Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.
$sel:resourceArns:CreateResourceShare'
, createResourceShare_resourceArns
- The ARNs of the resources to associate with the resource share.
$sel:permissionArns:CreateResourceShare'
, createResourceShare_permissionArns
- The Amazon Resource Names (ARNs) of the permissions 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. Only one permission can be associated with each resource
type in a resource share.
$sel:tags:CreateResourceShare'
, createResourceShare_tags
- One or more tags.
$sel:name:CreateResourceShare'
, createResourceShare_name
- 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:
$sel:clientToken:CreateResourceShare'
, createResourceShareResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShare:CreateResourceShareResponse'
, createResourceShareResponse_resourceShare
- Information about the resource share.
$sel:httpStatus:CreateResourceShareResponse'
, createResourceShareResponse_httpStatus
- The response's http status code.
ListPrincipals (Paginated)
data ListPrincipals Source #
See: newListPrincipals
smart constructor.
ListPrincipals' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Natural) (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:resourceType:ListPrincipals'
, listPrincipals_resourceType
- The resource type.
Valid values: acm-pca:CertificateAuthority
| appmesh:Mesh
|
codebuild:Project
| codebuild:ReportGroup
|
ec2:CapacityReservation
| ec2:DedicatedHost
|
ec2:LocalGatewayRouteTable
| ec2:PrefixList
| ec2:Subnet
|
ec2:TrafficMirrorTarget
| ec2:TransitGateway
|
imagebuilder:Component
| imagebuilder:Image
|
imagebuilder:ImageRecipe
| imagebuilder:ContainerRecipe
|
glue:Catalog
| glue:Database
| glue:Table
|
license-manager:LicenseConfiguration
I
network-firewall:FirewallPolicy
| network-firewall:StatefulRuleGroup
| network-firewall:StatelessRuleGroup
| outposts:Outpost
|
resource-groups:Group
| rds:Cluster
|
route53resolver:FirewallRuleGroup
|route53resolver:ResolverQueryLogConfig
|
route53resolver:ResolverRule
| s3-outposts:Outpost
|
ssm-contacts:Contact
| ssm-incidents:ResponsePlan
$sel:principals:ListPrincipals'
, listPrincipals_principals
- The principals.
$sel:nextToken:ListPrincipals'
, listPrincipals_nextToken
- The token for the next page of results.
$sel:resourceArn:ListPrincipals'
, listPrincipals_resourceArn
- The Amazon Resource Name (ARN) of the resource.
$sel:maxResults:ListPrincipals'
, listPrincipals_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:resourceShareArns:ListPrincipals'
, listPrincipals_resourceShareArns
- The Amazon Resource Names (ARN) of the resource shares.
$sel:resourceOwner:ListPrincipals'
, listPrincipals_resourceOwner
- The type of owner.
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:
$sel:principals:ListPrincipals'
, listPrincipalsResponse_principals
- The principals.
$sel:nextToken:ListPrincipals'
, listPrincipalsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:ListPrincipalsResponse'
, listPrincipalsResponse_httpStatus
- The response's http status code.
ListResources (Paginated)
data ListResources Source #
See: newListResources
smart constructor.
ListResources' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Natural) (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:resourceType:ListResources'
, listResources_resourceType
- The resource type.
Valid values: acm-pca:CertificateAuthority
| appmesh:Mesh
|
codebuild:Project
| codebuild:ReportGroup
|
ec2:CapacityReservation
| ec2:DedicatedHost
|
ec2:LocalGatewayRouteTable
| ec2:PrefixList
| ec2:Subnet
|
ec2:TrafficMirrorTarget
| ec2:TransitGateway
|
imagebuilder:Component
| imagebuilder:Image
|
imagebuilder:ImageRecipe
| imagebuilder:ContainerRecipe
|
glue:Catalog
| glue:Database
| glue:Table
|
license-manager:LicenseConfiguration
I
network-firewall:FirewallPolicy
| network-firewall:StatefulRuleGroup
| network-firewall:StatelessRuleGroup
| outposts:Outpost
|
resource-groups:Group
| rds:Cluster
|
route53resolver:FirewallRuleGroup
|route53resolver:ResolverQueryLogConfig
|
route53resolver:ResolverRule
| s3-outposts:Outpost
|
ssm-contacts:Contact
| ssm-incidents:ResponsePlan
$sel:nextToken:ListResources'
, listResources_nextToken
- The token for the next page of results.
$sel:resourceArns:ListResources'
, listResources_resourceArns
- The Amazon Resource Names (ARNs) of the resources.
$sel:principal:ListResources'
, listResources_principal
- The principal.
$sel:maxResults:ListResources'
, listResources_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:resourceShareArns:ListResources'
, listResources_resourceShareArns
- The Amazon Resource Names (ARN) of the resource shares.
$sel:resourceOwner:ListResources'
, listResources_resourceOwner
- The type of owner.
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:
$sel:resources:ListResourcesResponse'
, listResourcesResponse_resources
- Information about the resources.
$sel:nextToken:ListResources'
, listResourcesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:ListResourcesResponse'
, listResourcesResponse_httpStatus
- The response's http status code.
AcceptResourceShareInvitation
data AcceptResourceShareInvitation Source #
See: newAcceptResourceShareInvitation
smart constructor.
Instances
newAcceptResourceShareInvitation Source #
:: Text |
|
-> AcceptResourceShareInvitation |
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:
$sel:clientToken:AcceptResourceShareInvitation'
, acceptResourceShareInvitation_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShareInvitationArn:AcceptResourceShareInvitation'
, acceptResourceShareInvitation_resourceShareInvitationArn
- The Amazon Resource Name (ARN) of the invitation.
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:
$sel:clientToken:AcceptResourceShareInvitation'
, acceptResourceShareInvitationResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShareInvitation:AcceptResourceShareInvitationResponse'
, acceptResourceShareInvitationResponse_resourceShareInvitation
- Information about the invitation.
$sel:httpStatus:AcceptResourceShareInvitationResponse'
, acceptResourceShareInvitationResponse_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:
$sel:clientToken:DeleteResourceShare'
, deleteResourceShare_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShareArn:DeleteResourceShare'
, deleteResourceShare_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
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:
$sel:clientToken:DeleteResourceShare'
, deleteResourceShareResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:returnValue:DeleteResourceShareResponse'
, deleteResourceShareResponse_returnValue
- Indicates whether the request succeeded.
$sel:httpStatus:DeleteResourceShareResponse'
, deleteResourceShareResponse_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:
$sel:clientToken:UpdateResourceShare'
, updateResourceShare_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:allowExternalPrincipals:UpdateResourceShare'
, updateResourceShare_allowExternalPrincipals
- Indicates whether principals outside your organization in Organizations
can be associated with a resource share.
$sel:name:UpdateResourceShare'
, updateResourceShare_name
- The name of the resource share.
$sel:resourceShareArn:UpdateResourceShare'
, updateResourceShare_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
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:
$sel:clientToken:UpdateResourceShare'
, updateResourceShareResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShare:UpdateResourceShareResponse'
, updateResourceShareResponse_resourceShare
- Information about the resource share.
$sel:httpStatus:UpdateResourceShareResponse'
, updateResourceShareResponse_httpStatus
- The response's http status code.
RejectResourceShareInvitation
data RejectResourceShareInvitation Source #
See: newRejectResourceShareInvitation
smart constructor.
Instances
newRejectResourceShareInvitation Source #
:: Text |
|
-> RejectResourceShareInvitation |
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:
$sel:clientToken:RejectResourceShareInvitation'
, rejectResourceShareInvitation_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShareInvitationArn:RejectResourceShareInvitation'
, rejectResourceShareInvitation_resourceShareInvitationArn
- The Amazon Resource Name (ARN) of the invitation.
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:
$sel:clientToken:RejectResourceShareInvitation'
, rejectResourceShareInvitationResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShareInvitation:RejectResourceShareInvitationResponse'
, rejectResourceShareInvitationResponse_resourceShareInvitation
- Information about the invitation.
$sel:httpStatus:RejectResourceShareInvitationResponse'
, rejectResourceShareInvitationResponse_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:resourceType:ListPermissions'
, listPermissions_resourceType
- Specifies the resource type for which to list permissions. For example,
to list only permissions that apply to EC2 subnets, specify
ec2:Subnet
.
$sel:nextToken:ListPermissions'
, listPermissions_nextToken
- The token for the next page of results.
$sel:maxResults:ListPermissions'
, listPermissions_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
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:
$sel:nextToken:ListPermissions'
, listPermissionsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:permissions:ListPermissionsResponse'
, listPermissionsResponse_permissions
- Information about the permissions.
$sel:httpStatus:ListPermissionsResponse'
, listPermissionsResponse_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:
$sel:clientToken:DisassociateResourceShare'
, disassociateResourceShare_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:principals:DisassociateResourceShare'
, disassociateResourceShare_principals
- The principals.
$sel:resourceArns:DisassociateResourceShare'
, disassociateResourceShare_resourceArns
- The Amazon Resource Names (ARNs) of the resources.
$sel:resourceShareArn:DisassociateResourceShare'
, disassociateResourceShare_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
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:
$sel:clientToken:DisassociateResourceShare'
, disassociateResourceShareResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShareAssociations:DisassociateResourceShareResponse'
, disassociateResourceShareResponse_resourceShareAssociations
- Information about the associations.
$sel:httpStatus:DisassociateResourceShareResponse'
, disassociateResourceShareResponse_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:nextToken:ListResourceSharePermissions'
, listResourceSharePermissions_nextToken
- The token for the next page of results.
$sel:maxResults:ListResourceSharePermissions'
, listResourceSharePermissions_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:resourceShareArn:ListResourceSharePermissions'
, listResourceSharePermissions_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
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:
$sel:nextToken:ListResourceSharePermissions'
, listResourceSharePermissionsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:permissions:ListResourceSharePermissionsResponse'
, listResourceSharePermissionsResponse_permissions
- The permissions associated with the resource share.
$sel:httpStatus:ListResourceSharePermissionsResponse'
, listResourceSharePermissionsResponse_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:
$sel:resourceShareArn:TagResource'
, tagResource_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:tags:TagResource'
, tagResource_tags
- One or more tags.
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.
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:nextToken:ListResourceTypes'
, listResourceTypes_nextToken
- The token for the next page of results.
$sel:maxResults:ListResourceTypes'
, listResourceTypes_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
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:
$sel:nextToken:ListResourceTypes'
, listResourceTypesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:resourceTypes:ListResourceTypesResponse'
, listResourceTypesResponse_resourceTypes
- The shareable resource types supported by RAM.
$sel:httpStatus:ListResourceTypesResponse'
, listResourceTypesResponse_httpStatus
- The response's http status code.
GetResourceShareAssociations (Paginated)
data GetResourceShareAssociations Source #
See: newGetResourceShareAssociations
smart constructor.
GetResourceShareAssociations' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ResourceShareAssociationStatus) (Maybe Natural) (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:nextToken:GetResourceShareAssociations'
, getResourceShareAssociations_nextToken
- The token for the next page of results.
$sel:resourceArn:GetResourceShareAssociations'
, getResourceShareAssociations_resourceArn
- The Amazon Resource Name (ARN) of the resource. You cannot specify this
parameter if the association type is PRINCIPAL
.
$sel:principal:GetResourceShareAssociations'
, getResourceShareAssociations_principal
- The principal. You cannot specify this parameter if the association type
is RESOURCE
.
$sel:associationStatus:GetResourceShareAssociations'
, getResourceShareAssociations_associationStatus
- The association status.
$sel:maxResults:GetResourceShareAssociations'
, getResourceShareAssociations_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:resourceShareArns:GetResourceShareAssociations'
, getResourceShareAssociations_resourceShareArns
- The Amazon Resource Names (ARN) of the resource shares.
$sel:associationType:GetResourceShareAssociations'
, getResourceShareAssociations_associationType
- The association type. Specify PRINCIPAL
to list the principals that
are associated with the specified resource share. Specify RESOURCE
to
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:
$sel:resourceShareAssociations:GetResourceShareAssociationsResponse'
, getResourceShareAssociationsResponse_resourceShareAssociations
- Information about the associations.
$sel:nextToken:GetResourceShareAssociations'
, getResourceShareAssociationsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$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:nextToken:GetResourceShareInvitations'
, getResourceShareInvitations_nextToken
- The token for the next page of results.
$sel:resourceShareInvitationArns:GetResourceShareInvitations'
, getResourceShareInvitations_resourceShareInvitationArns
- The Amazon Resource Names (ARN) of the invitations.
$sel:maxResults:GetResourceShareInvitations'
, getResourceShareInvitations_maxResults
- The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
$sel:resourceShareArns:GetResourceShareInvitations'
, getResourceShareInvitations_resourceShareArns
- The Amazon Resource Names (ARN) of the resource shares.
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:
$sel:resourceShareInvitations:GetResourceShareInvitationsResponse'
, getResourceShareInvitationsResponse_resourceShareInvitations
- Information about the invitations.
$sel:nextToken:GetResourceShareInvitations'
, getResourceShareInvitationsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:GetResourceShareInvitationsResponse'
, getResourceShareInvitationsResponse_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:
$sel:resourceShareArn:UntagResource'
, untagResource_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag keys of the tags 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.
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:
$sel:clientToken:AssociateResourceShare'
, associateResourceShare_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:principals:AssociateResourceShare'
, associateResourceShare_principals
- The principals to associate with the resource share. The possible values
are:
- An Amazon Web Services account ID
- An Amazon Resource Name (ARN) of an organization in Organizations
- An ARN of an organizational unit (OU) in Organizations
- An ARN of an IAM role
- An ARN of an IAM user
Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.
$sel:resourceArns:AssociateResourceShare'
, associateResourceShare_resourceArns
- The Amazon Resource Names (ARNs) of the resources.
$sel:resourceShareArn:AssociateResourceShare'
, associateResourceShare_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
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:
$sel:clientToken:AssociateResourceShare'
, associateResourceShareResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShareAssociations:AssociateResourceShareResponse'
, associateResourceShareResponse_resourceShareAssociations
- Information about the associations.
$sel:httpStatus:AssociateResourceShareResponse'
, associateResourceShareResponse_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:
$sel:clientToken:DisassociateResourceSharePermission'
, disassociateResourceSharePermission_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:resourceShareArn:DisassociateResourceSharePermission'
, disassociateResourceSharePermission_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:permissionArn:DisassociateResourceSharePermission'
, disassociateResourceSharePermission_permissionArn
- The Amazon Resource Name (ARN) of the permission to disassociate from
the resource share.
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:
$sel:clientToken:DisassociateResourceSharePermission'
, disassociateResourceSharePermissionResponse_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:returnValue:DisassociateResourceSharePermissionResponse'
, disassociateResourceSharePermissionResponse_returnValue
- Indicates whether the request succeeded.
$sel:httpStatus:DisassociateResourceSharePermissionResponse'
, disassociateResourceSharePermissionResponse_httpStatus
- The response's http status code.
Types
ResourceOwner
newtype ResourceOwner Source #
pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner | |
pattern ResourceOwner_SELF :: ResourceOwner |
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 time when the principal was associated with the resource share.
$sel:resourceShareArn:Principal'
, principal_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:lastUpdatedTime:Principal'
, principal_lastUpdatedTime
- The time when the association was last updated.
$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.
Resource
Describes a resource associated with a resource share.
See: newResource
smart constructor.
Resource' (Maybe POSIX) (Maybe ResourceStatus) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (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:creationTime:Resource'
, resource_creationTime
- The time when the resource was associated with the resource share.
$sel:status:Resource'
, resource_status
- The status of the resource.
$sel:resourceShareArn:Resource'
, resource_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:lastUpdatedTime:Resource'
, resource_lastUpdatedTime
- The time when the association was last updated.
$sel:arn:Resource'
, resource_arn
- The Amazon Resource Name (ARN) of the resource.
$sel:resourceGroupArn:Resource'
, resource_resourceGroupArn
- The Amazon Resource Name (ARN) of the resource group. This value is
returned only if the resource is a resource group.
$sel:statusMessage:Resource'
, resource_statusMessage
- A message about the status of the resource.
$sel:type':Resource'
, resource_type
- The resource type.
ResourceShare
data ResourceShare Source #
Describes a resource share.
See: newResourceShare
smart constructor.
ResourceShare' (Maybe POSIX) (Maybe ResourceShareStatus) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ResourceShareFeatureSet) (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:creationTime:ResourceShare'
, resourceShare_creationTime
- The time when the resource share was created.
$sel:status:ResourceShare'
, resourceShare_status
- The status of the resource share.
$sel:resourceShareArn:ResourceShare'
, resourceShare_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:owningAccountId:ResourceShare'
, resourceShare_owningAccountId
- The ID of the Amazon Web Services account that owns the resource share.
$sel:lastUpdatedTime:ResourceShare'
, resourceShare_lastUpdatedTime
- The time when the resource share was last updated.
$sel:allowExternalPrincipals:ResourceShare'
, resourceShare_allowExternalPrincipals
- Indicates whether principals outside your organization in Organizations
can be associated with a resource share.
$sel:name:ResourceShare'
, resourceShare_name
- The name of the resource share.
$sel:statusMessage:ResourceShare'
, resourceShare_statusMessage
- A message about the status of the resource share.
$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 Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource. These resource shares are visible only to the Amazon Web Services account that created it. They cannot be modified in RAM.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. They can be modified in RAM.
$sel:tags:ResourceShare'
, resourceShare_tags
- The tags for the resource share.
ResourceShareAssociation
data ResourceShareAssociation Source #
Describes an association with a resource share.
See: newResourceShareAssociation
smart constructor.
ResourceShareAssociation' (Maybe POSIX) (Maybe ResourceShareAssociationStatus) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe ResourceShareAssociationType) (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:creationTime:ResourceShareAssociation'
, resourceShareAssociation_creationTime
- The time when the association was created.
$sel:status:ResourceShareAssociation'
, resourceShareAssociation_status
- The status of the association.
$sel:resourceShareArn:ResourceShareAssociation'
, resourceShareAssociation_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:lastUpdatedTime:ResourceShareAssociation'
, resourceShareAssociation_lastUpdatedTime
- The time when the association was last updated.
$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:resourceShareName:ResourceShareAssociation'
, resourceShareAssociation_resourceShareName
- The name of the resource share.
$sel:associatedEntity:ResourceShareAssociation'
, resourceShareAssociation_associatedEntity
- The associated entity. For resource associations, this is the Amazon
Resource Name (ARN) of the resource. For principal associations, this is
one of the following:
- An Amazon Web Services account ID
- An ARN of an organization in Organizations
- An ARN of an organizational unit (OU) in Organizations
- An ARN of an IAM role
- An ARN of an IAM user
$sel:associationType:ResourceShareAssociation'
, resourceShareAssociation_associationType
- The association type.
$sel:statusMessage:ResourceShareAssociation'
, resourceShareAssociation_statusMessage
- A message about the status of the association.
ResourceShareInvitation
data ResourceShareInvitation Source #
Describes an invitation to join a resource share.
See: newResourceShareInvitation
smart constructor.
ResourceShareInvitation' (Maybe ResourceShareInvitationStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ResourceShareAssociation]) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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:status:ResourceShareInvitation'
, resourceShareInvitation_status
- The status of the invitation.
$sel:senderAccountId:ResourceShareInvitation'
, resourceShareInvitation_senderAccountId
- The ID of the Amazon Web Services account that sent the invitation.
$sel:resourceShareArn:ResourceShareInvitation'
, resourceShareInvitation_resourceShareArn
- The Amazon Resource Name (ARN) of the resource share.
$sel:receiverAccountId:ResourceShareInvitation'
, resourceShareInvitation_receiverAccountId
- The ID of the Amazon Web Services account that received the invitation.
$sel:resourceShareAssociations:ResourceShareInvitation'
, resourceShareInvitation_resourceShareAssociations
- To view the resources associated with a pending resource share
invitation, use
ListPendingInvitationResources.
$sel:resourceShareName:ResourceShareInvitation'
, resourceShareInvitation_resourceShareName
- The name of the resource share.
$sel:receiverArn:ResourceShareInvitation'
, resourceShareInvitation_receiverArn
- The Amazon Resource Name (ARN) of the IAM user or IAM role that received
the invitation.
$sel:invitationTimestamp:ResourceShareInvitation'
, resourceShareInvitation_invitationTimestamp
- The date and time when the invitation was sent.
$sel:resourceShareInvitationArn:ResourceShareInvitation'
, resourceShareInvitation_resourceShareInvitationArn
- The Amazon Resource Name (ARN) of the invitation.
ResourceSharePermissionDetail
data ResourceSharePermissionDetail Source #
Information about an RAM permission.
See: newResourceSharePermissionDetail
smart constructor.
ResourceSharePermissionDetail' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (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:creationTime:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_creationTime
- The date and time when the permission was created.
$sel:resourceType:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_resourceType
- The resource type to which the permission applies.
$sel:lastUpdatedTime:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_lastUpdatedTime
- The date and time when the permission was last updated.
$sel:arn:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_arn
- The Amazon Resource Name (ARN) of the permission.
$sel:defaultVersion:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_defaultVersion
- Specifies whether the version of the permission is set to the default
version for this permission.
$sel:name:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_name
- The name of the permission.
$sel:version:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_version
- The identifier for the version of the permission.
$sel:isResourceTypeDefault:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_isResourceTypeDefault
- Specifies whether the version of the permission is set to the default
version for this resource type.
$sel:permission:ResourceSharePermissionDetail'
, resourceSharePermissionDetail_permission
- The permission's effect and actions in JSON format. The effect
indicates whether the actions are allowed or denied. The actions
list
the API actions to which the principal is granted or denied access.
ResourceSharePermissionSummary
data ResourceSharePermissionSummary Source #
Information about a permission that is associated with a resource share.
See: newResourceSharePermissionSummary
smart constructor.
ResourceSharePermissionSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) |
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:creationTime:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_creationTime
- The date and time when the permission was created.
$sel:status:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_status
- The current status of the permission.
$sel:resourceType:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_resourceType
- The type of resource to which the permission applies.
$sel:lastUpdatedTime:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_lastUpdatedTime
- The date and time when the permission was last updated.
$sel:arn:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_arn
- The Amazon Resource Name (ARN) of the permission.
$sel:defaultVersion:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_defaultVersion
- Specifies whether the version of the permission is set to the default
version for this permission.
$sel:name:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_name
- The name of the permission.
$sel:version:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_version
- The identifier for the version of the permission.
$sel:isResourceTypeDefault:ResourceSharePermissionSummary'
, resourceSharePermissionSummary_isResourceTypeDefault
- Specifies whether the version of the permission is set to the default
version for this resource type.
ServiceNameAndResourceType
data ServiceNameAndResourceType Source #
Information about the shareable resource types and the Amazon Web Services services to which they 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:resourceType:ServiceNameAndResourceType'
, serviceNameAndResourceType_resourceType
- The shareable resource types.
$sel:serviceName:ServiceNameAndResourceType'
, serviceNameAndResourceType_serviceName
- The name of the Amazon Web Services services to which the resources
belong.
Tag
Information about a tag.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.RAM.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.RAM.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.RAM.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.RAM.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.RAM.Types.Tag" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") '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:value:Tag'
, tag_value
- The value of the tag.
$sel:key:Tag'
, tag_key
- The key of the tag.
TagFilter
Used to filter information based on tags.
See: newTagFilter
smart constructor.
TagFilter' (Maybe [Text]) (Maybe Text) |
Instances
Eq TagFilter Source # | |
Read TagFilter Source # | |
Show TagFilter Source # | |
Generic TagFilter Source # | |
NFData TagFilter Source # | |
Defined in Amazonka.RAM.Types.TagFilter | |
Hashable TagFilter Source # | |
Defined in Amazonka.RAM.Types.TagFilter | |
ToJSON 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" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "TagFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tagKey") '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:tagValues:TagFilter'
, tagFilter_tagValues
- The tag values.
$sel:tagKey:TagFilter'
, tagFilter_tagKey
- The tag key.