| 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 |
Amazonka.RAM.Types
Contents
- Service Configuration
- Errors
- ResourceOwner
- ResourceRegionScope
- ResourceRegionScopeFilter
- ResourceShareAssociationStatus
- ResourceShareAssociationType
- ResourceShareFeatureSet
- ResourceShareInvitationStatus
- ResourceShareStatus
- ResourceStatus
- Principal
- Resource
- ResourceShare
- ResourceShareAssociation
- ResourceShareInvitation
- ResourceSharePermissionDetail
- ResourceSharePermissionSummary
- ServiceNameAndResourceType
- Tag
- TagFilter
Description
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
- 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' {
- creationTime :: Maybe POSIX
- external :: Maybe Bool
- id :: Maybe Text
- lastUpdatedTime :: Maybe POSIX
- resourceShareArn :: Maybe Text
- newPrincipal :: Principal
- principal_creationTime :: Lens' Principal (Maybe UTCTime)
- principal_external :: Lens' Principal (Maybe Bool)
- principal_id :: Lens' Principal (Maybe Text)
- principal_lastUpdatedTime :: Lens' Principal (Maybe UTCTime)
- principal_resourceShareArn :: Lens' Principal (Maybe Text)
- data Resource = Resource' {}
- newResource :: Resource
- resource_arn :: Lens' Resource (Maybe Text)
- resource_creationTime :: Lens' Resource (Maybe UTCTime)
- resource_lastUpdatedTime :: Lens' Resource (Maybe UTCTime)
- resource_resourceGroupArn :: Lens' Resource (Maybe Text)
- resource_resourceRegionScope :: Lens' Resource (Maybe ResourceRegionScope)
- resource_resourceShareArn :: Lens' Resource (Maybe Text)
- resource_status :: Lens' Resource (Maybe ResourceStatus)
- resource_statusMessage :: Lens' Resource (Maybe Text)
- resource_type :: Lens' Resource (Maybe Text)
- data ResourceShare = ResourceShare' {}
- newResourceShare :: ResourceShare
- resourceShare_allowExternalPrincipals :: Lens' ResourceShare (Maybe Bool)
- resourceShare_creationTime :: Lens' ResourceShare (Maybe UTCTime)
- resourceShare_featureSet :: Lens' ResourceShare (Maybe ResourceShareFeatureSet)
- resourceShare_lastUpdatedTime :: Lens' ResourceShare (Maybe UTCTime)
- resourceShare_name :: Lens' ResourceShare (Maybe Text)
- resourceShare_owningAccountId :: Lens' ResourceShare (Maybe Text)
- resourceShare_resourceShareArn :: Lens' ResourceShare (Maybe Text)
- resourceShare_status :: Lens' ResourceShare (Maybe ResourceShareStatus)
- resourceShare_statusMessage :: Lens' ResourceShare (Maybe Text)
- resourceShare_tags :: Lens' ResourceShare (Maybe [Tag])
- data ResourceShareAssociation = ResourceShareAssociation' {}
- newResourceShareAssociation :: ResourceShareAssociation
- resourceShareAssociation_associatedEntity :: Lens' ResourceShareAssociation (Maybe Text)
- resourceShareAssociation_associationType :: Lens' ResourceShareAssociation (Maybe ResourceShareAssociationType)
- resourceShareAssociation_creationTime :: Lens' ResourceShareAssociation (Maybe UTCTime)
- resourceShareAssociation_external :: Lens' ResourceShareAssociation (Maybe Bool)
- resourceShareAssociation_lastUpdatedTime :: Lens' ResourceShareAssociation (Maybe UTCTime)
- resourceShareAssociation_resourceShareArn :: Lens' ResourceShareAssociation (Maybe Text)
- resourceShareAssociation_resourceShareName :: Lens' ResourceShareAssociation (Maybe Text)
- resourceShareAssociation_status :: Lens' ResourceShareAssociation (Maybe ResourceShareAssociationStatus)
- resourceShareAssociation_statusMessage :: Lens' ResourceShareAssociation (Maybe Text)
- data ResourceShareInvitation = ResourceShareInvitation' {
- invitationTimestamp :: Maybe POSIX
- receiverAccountId :: Maybe Text
- receiverArn :: Maybe Text
- resourceShareArn :: Maybe Text
- resourceShareAssociations :: Maybe [ResourceShareAssociation]
- resourceShareInvitationArn :: Maybe Text
- resourceShareName :: Maybe Text
- senderAccountId :: Maybe Text
- status :: Maybe ResourceShareInvitationStatus
- newResourceShareInvitation :: ResourceShareInvitation
- resourceShareInvitation_invitationTimestamp :: Lens' ResourceShareInvitation (Maybe UTCTime)
- resourceShareInvitation_receiverAccountId :: Lens' ResourceShareInvitation (Maybe Text)
- resourceShareInvitation_receiverArn :: Lens' ResourceShareInvitation (Maybe Text)
- resourceShareInvitation_resourceShareArn :: Lens' ResourceShareInvitation (Maybe Text)
- resourceShareInvitation_resourceShareAssociations :: Lens' ResourceShareInvitation (Maybe [ResourceShareAssociation])
- resourceShareInvitation_resourceShareInvitationArn :: Lens' ResourceShareInvitation (Maybe Text)
- resourceShareInvitation_resourceShareName :: Lens' ResourceShareInvitation (Maybe Text)
- resourceShareInvitation_senderAccountId :: Lens' ResourceShareInvitation (Maybe Text)
- resourceShareInvitation_status :: Lens' ResourceShareInvitation (Maybe ResourceShareInvitationStatus)
- data ResourceSharePermissionDetail = ResourceSharePermissionDetail' {}
- newResourceSharePermissionDetail :: ResourceSharePermissionDetail
- resourceSharePermissionDetail_arn :: Lens' ResourceSharePermissionDetail (Maybe Text)
- resourceSharePermissionDetail_creationTime :: Lens' ResourceSharePermissionDetail (Maybe UTCTime)
- resourceSharePermissionDetail_defaultVersion :: Lens' ResourceSharePermissionDetail (Maybe Bool)
- resourceSharePermissionDetail_isResourceTypeDefault :: Lens' ResourceSharePermissionDetail (Maybe Bool)
- resourceSharePermissionDetail_lastUpdatedTime :: Lens' ResourceSharePermissionDetail (Maybe UTCTime)
- resourceSharePermissionDetail_name :: Lens' ResourceSharePermissionDetail (Maybe Text)
- resourceSharePermissionDetail_permission :: Lens' ResourceSharePermissionDetail (Maybe Text)
- resourceSharePermissionDetail_resourceType :: Lens' ResourceSharePermissionDetail (Maybe Text)
- resourceSharePermissionDetail_version :: Lens' ResourceSharePermissionDetail (Maybe Text)
- data ResourceSharePermissionSummary = ResourceSharePermissionSummary' {}
- newResourceSharePermissionSummary :: ResourceSharePermissionSummary
- resourceSharePermissionSummary_arn :: Lens' ResourceSharePermissionSummary (Maybe Text)
- resourceSharePermissionSummary_creationTime :: Lens' ResourceSharePermissionSummary (Maybe UTCTime)
- resourceSharePermissionSummary_defaultVersion :: Lens' ResourceSharePermissionSummary (Maybe Bool)
- resourceSharePermissionSummary_isResourceTypeDefault :: Lens' ResourceSharePermissionSummary (Maybe Bool)
- resourceSharePermissionSummary_lastUpdatedTime :: Lens' ResourceSharePermissionSummary (Maybe UTCTime)
- resourceSharePermissionSummary_name :: Lens' ResourceSharePermissionSummary (Maybe Text)
- resourceSharePermissionSummary_resourceType :: Lens' ResourceSharePermissionSummary (Maybe Text)
- resourceSharePermissionSummary_status :: Lens' ResourceSharePermissionSummary (Maybe Text)
- resourceSharePermissionSummary_version :: Lens' ResourceSharePermissionSummary (Maybe Text)
- data ServiceNameAndResourceType = ServiceNameAndResourceType' {}
- newServiceNameAndResourceType :: ServiceNameAndResourceType
- serviceNameAndResourceType_resourceRegionScope :: Lens' ServiceNameAndResourceType (Maybe ResourceRegionScope)
- serviceNameAndResourceType_resourceType :: Lens' ServiceNameAndResourceType (Maybe Text)
- serviceNameAndResourceType_serviceName :: Lens' ServiceNameAndResourceType (Maybe Text)
- data Tag = Tag' {}
- newTag :: Tag
- tag_key :: Lens' Tag (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
- data TagFilter = TagFilter' {}
- newTagFilter :: TagFilter
- tagFilter_tagKey :: Lens' TagFilter (Maybe Text)
- tagFilter_tagValues :: Lens' TagFilter (Maybe [Text])
Service Configuration
defaultService :: Service Source #
API version 2018-01-04 of the Amazon Resource Access Manager SDK configuration.
Errors
_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 :: AsError a => Fold a ServiceError Source #
The client token is not valid.
_InvalidMaxResultsException :: AsError a => Fold a ServiceError Source #
The specified value for MaxResults is not valid.
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The specified value for NextToken is not valid.
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
A parameter is not valid.
_InvalidResourceTypeException :: AsError a => Fold a ServiceError Source #
The specified resource type is not valid.
_InvalidStateTransitionException :: AsError a => Fold a ServiceError Source #
The requested state transition is not valid.
_MalformedArnException :: AsError a => Fold a ServiceError Source #
The format of an Amazon Resource Name (ARN) is not valid.
_MissingRequiredParameterException :: AsError a => Fold a ServiceError Source #
A required input parameter is missing.
_OperationNotPermittedException :: AsError a => Fold a ServiceError Source #
The requested operation is not permitted.
_ResourceArnNotFoundException :: AsError a => Fold a ServiceError Source #
The specified Amazon Resource Name (ARN) was not found.
_ResourceShareInvitationAlreadyAcceptedException :: AsError a => Fold a ServiceError Source #
The specified invitation was already accepted.
_ResourceShareInvitationAlreadyRejectedException :: AsError a => Fold a ServiceError Source #
The specified invitation was already rejected.
_ResourceShareInvitationArnNotFoundException :: AsError a => Fold a ServiceError Source #
The specified Amazon Resource Name (ARN) for an invitation was not found.
_ResourceShareInvitationExpiredException :: AsError a => Fold a ServiceError Source #
The specified invitation is expired.
_ResourceShareLimitExceededException :: AsError a => Fold a ServiceError Source #
This request would exceed the limit for resource shares for your account.
_ServerInternalException :: AsError a => Fold a ServiceError Source #
The service could not respond to the request due to an internal problem.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is not available.
_TagLimitExceededException :: AsError a => Fold a ServiceError Source #
This request would exceed the limit for tags for your account.
_TagPolicyViolationException :: AsError a => Fold a ServiceError Source #
The specified tag key is a reserved word and can't be used.
_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 :: AsError a => Fold a ServiceError Source #
A specified resource was not found.
ResourceOwner
newtype ResourceOwner Source #
Constructors
| ResourceOwner' | |
Fields | |
Bundled Patterns
| pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner | |
| pattern ResourceOwner_SELF :: ResourceOwner |
Instances
ResourceRegionScope
newtype ResourceRegionScope Source #
Constructors
| ResourceRegionScope' | |
Fields | |
Bundled Patterns
| pattern ResourceRegionScope_GLOBAL :: ResourceRegionScope | |
| pattern ResourceRegionScope_REGIONAL :: ResourceRegionScope |
Instances
ResourceRegionScopeFilter
newtype ResourceRegionScopeFilter Source #
Constructors
| ResourceRegionScopeFilter' | |
Fields | |
Bundled Patterns
Instances
ResourceShareAssociationStatus
newtype ResourceShareAssociationStatus Source #
Constructors
| ResourceShareAssociationStatus' | |
Fields | |
Bundled Patterns
Instances
ResourceShareAssociationType
newtype ResourceShareAssociationType Source #
Constructors
| ResourceShareAssociationType' | |
Fields | |
Bundled Patterns
| pattern ResourceShareAssociationType_PRINCIPAL :: ResourceShareAssociationType | |
| pattern ResourceShareAssociationType_RESOURCE :: ResourceShareAssociationType |
Instances
ResourceShareFeatureSet
newtype ResourceShareFeatureSet Source #
Constructors
| ResourceShareFeatureSet' | |
Fields | |
Bundled Patterns
Instances
ResourceShareInvitationStatus
newtype ResourceShareInvitationStatus Source #
Constructors
| ResourceShareInvitationStatus' | |
Fields | |
Bundled Patterns
Instances
ResourceShareStatus
newtype ResourceShareStatus Source #
Constructors
| ResourceShareStatus' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| ResourceStatus' | |
Fields | |
Bundled Patterns
| 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.
Constructors
| Principal' | |
Fields
| |
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.
principal_creationTime :: Lens' Principal (Maybe UTCTime) Source #
The date and time when the principal was associated with the resource share.
principal_external :: Lens' Principal (Maybe Bool) Source #
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
principal_lastUpdatedTime :: Lens' Principal (Maybe UTCTime) Source #
The date and time when the association was last updated.
principal_resourceShareArn :: Lens' Principal (Maybe Text) Source #
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.
Constructors
| Resource' | |
Fields
| |
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
resource_arn :: Lens' Resource (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the resource.
resource_creationTime :: Lens' Resource (Maybe UTCTime) Source #
The date and time when the resource was associated with the resource share.
resource_lastUpdatedTime :: Lens' Resource (Maybe UTCTime) Source #
The date an time when the association was last updated.
resource_resourceGroupArn :: Lens' Resource (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.
resource_resourceRegionScope :: Lens' Resource (Maybe ResourceRegionScope) Source #
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.
resource_resourceShareArn :: Lens' Resource (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the resource share this resource is associated with.
resource_status :: Lens' Resource (Maybe ResourceStatus) Source #
The current status of the resource.
resource_statusMessage :: Lens' Resource (Maybe Text) Source #
A message about the status of the resource.
resource_type :: Lens' Resource (Maybe Text) Source #
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.
Constructors
| ResourceShare' | |
Fields
| |
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.
resourceShare_allowExternalPrincipals :: Lens' ResourceShare (Maybe Bool) Source #
Indicates whether principals outside your organization in Organizations can be associated with a resource share.
resourceShare_creationTime :: Lens' ResourceShare (Maybe UTCTime) Source #
The date and time when the resource share was created.
resourceShare_featureSet :: Lens' ResourceShare (Maybe ResourceShareFeatureSet) Source #
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.
resourceShare_lastUpdatedTime :: Lens' ResourceShare (Maybe UTCTime) Source #
The date and time when the resource share was last updated.
resourceShare_name :: Lens' ResourceShare (Maybe Text) Source #
The name of the resource share.
resourceShare_owningAccountId :: Lens' ResourceShare (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the resource share.
resourceShare_resourceShareArn :: Lens' ResourceShare (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the resource share
resourceShare_status :: Lens' ResourceShare (Maybe ResourceShareStatus) Source #
The current status of the resource share.
resourceShare_statusMessage :: Lens' ResourceShare (Maybe Text) Source #
A message about the status of the resource share.
resourceShare_tags :: Lens' ResourceShare (Maybe [Tag]) Source #
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.
Constructors
| ResourceShareAssociation' | |
Fields
| |
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.
resourceShareAssociation_associatedEntity :: Lens' ResourceShareAssociation (Maybe Text) Source #
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
resourceShareAssociation_associationType :: Lens' ResourceShareAssociation (Maybe ResourceShareAssociationType) Source #
The type of entity included in this association.
resourceShareAssociation_creationTime :: Lens' ResourceShareAssociation (Maybe UTCTime) Source #
The date and time when the association was created.
resourceShareAssociation_external :: Lens' ResourceShareAssociation (Maybe Bool) Source #
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
resourceShareAssociation_lastUpdatedTime :: Lens' ResourceShareAssociation (Maybe UTCTime) Source #
The date and time when the association was last updated.
resourceShareAssociation_resourceShareArn :: Lens' ResourceShareAssociation (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the resource share.
resourceShareAssociation_resourceShareName :: Lens' ResourceShareAssociation (Maybe Text) Source #
The name of the resource share.
resourceShareAssociation_status :: Lens' ResourceShareAssociation (Maybe ResourceShareAssociationStatus) Source #
The current status of the association.
resourceShareAssociation_statusMessage :: Lens' ResourceShareAssociation (Maybe Text) Source #
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.
Constructors
| ResourceShareInvitation' | |
Fields
| |
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.
resourceShareInvitation_invitationTimestamp :: Lens' ResourceShareInvitation (Maybe UTCTime) Source #
The date and time when the invitation was sent.
resourceShareInvitation_receiverAccountId :: Lens' ResourceShareInvitation (Maybe Text) Source #
The ID of the Amazon Web Services account that received the invitation.
resourceShareInvitation_receiverArn :: Lens' ResourceShareInvitation (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the IAM user or role that received the invitation.
resourceShareInvitation_resourceShareArn :: Lens' ResourceShareInvitation (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the resource share
resourceShareInvitation_resourceShareAssociations :: Lens' ResourceShareInvitation (Maybe [ResourceShareAssociation]) Source #
To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.
resourceShareInvitation_resourceShareInvitationArn :: Lens' ResourceShareInvitation (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the invitation.
resourceShareInvitation_resourceShareName :: Lens' ResourceShareInvitation (Maybe Text) Source #
The name of the resource share.
resourceShareInvitation_senderAccountId :: Lens' ResourceShareInvitation (Maybe Text) Source #
The ID of the Amazon Web Services account that sent the invitation.
resourceShareInvitation_status :: Lens' ResourceShareInvitation (Maybe ResourceShareInvitationStatus) Source #
The current status of the invitation.
ResourceSharePermissionDetail
data ResourceSharePermissionDetail Source #
Information about an RAM permission.
See: newResourceSharePermissionDetail smart constructor.
Constructors
| ResourceSharePermissionDetail' | |
Fields
| |
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.
resourceSharePermissionDetail_arn :: Lens' ResourceSharePermissionDetail (Maybe Text) Source #
The Amazon Resoure Name (ARN) of this RAM permission.
resourceSharePermissionDetail_creationTime :: Lens' ResourceSharePermissionDetail (Maybe UTCTime) Source #
The date and time when the permission was created.
resourceSharePermissionDetail_defaultVersion :: Lens' ResourceSharePermissionDetail (Maybe Bool) Source #
Specifies whether the version of the permission represented in this structure is the default version for this permission.
resourceSharePermissionDetail_isResourceTypeDefault :: Lens' ResourceSharePermissionDetail (Maybe Bool) Source #
Specifies whether the version of the permission represented in this structure is the default version for all resources of this resource type.
resourceSharePermissionDetail_lastUpdatedTime :: Lens' ResourceSharePermissionDetail (Maybe UTCTime) Source #
The date and time when the permission was last updated.
resourceSharePermissionDetail_name :: Lens' ResourceSharePermissionDetail (Maybe Text) Source #
The name of this permission.
resourceSharePermissionDetail_permission :: Lens' ResourceSharePermissionDetail (Maybe Text) Source #
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.
resourceSharePermissionDetail_resourceType :: Lens' ResourceSharePermissionDetail (Maybe Text) Source #
The resource type to which this permission applies.
resourceSharePermissionDetail_version :: Lens' ResourceSharePermissionDetail (Maybe Text) Source #
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.
Constructors
| ResourceSharePermissionSummary' | |
Fields
| |
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.
resourceSharePermissionSummary_arn :: Lens' ResourceSharePermissionSummary (Maybe Text) Source #
The Amazon Resoure Name (ARN) of the permission you want information about.
resourceSharePermissionSummary_creationTime :: Lens' ResourceSharePermissionSummary (Maybe UTCTime) Source #
The date and time when the permission was created.
resourceSharePermissionSummary_defaultVersion :: Lens' ResourceSharePermissionSummary (Maybe Bool) Source #
Specifies whether the version of the permission represented in this structure is the default version for this permission.
resourceSharePermissionSummary_isResourceTypeDefault :: Lens' ResourceSharePermissionSummary (Maybe Bool) Source #
Specifies whether the version of the permission represented in this structure is the default version for all resources of this resource type.
resourceSharePermissionSummary_lastUpdatedTime :: Lens' ResourceSharePermissionSummary (Maybe UTCTime) Source #
The date and time when the permission was last updated.
resourceSharePermissionSummary_name :: Lens' ResourceSharePermissionSummary (Maybe Text) Source #
The name of this permission.
resourceSharePermissionSummary_resourceType :: Lens' ResourceSharePermissionSummary (Maybe Text) Source #
The type of resource to which this permission applies.
resourceSharePermissionSummary_status :: Lens' ResourceSharePermissionSummary (Maybe Text) Source #
The current status of the permission.
resourceSharePermissionSummary_version :: Lens' ResourceSharePermissionSummary (Maybe Text) Source #
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.
Constructors
| ServiceNameAndResourceType' | |
Fields
| |
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.
serviceNameAndResourceType_resourceRegionScope :: Lens' ServiceNameAndResourceType (Maybe ResourceRegionScope) Source #
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.
serviceNameAndResourceType_resourceType :: Lens' ServiceNameAndResourceType (Maybe Text) Source #
The type of the resource.
serviceNameAndResourceType_serviceName :: Lens' ServiceNameAndResourceType (Maybe Text) Source #
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.
Constructors
| Tag' | |
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.
tag_key :: Lens' Tag (Maybe Text) Source #
The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.
tag_value :: Lens' Tag (Maybe Text) Source #
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.
Constructors
| TagFilter' | |
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.