| 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.ResourceExplorer2.Types
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype IndexState where
- IndexState' { }
- pattern IndexState_ACTIVE :: IndexState
- pattern IndexState_CREATING :: IndexState
- pattern IndexState_DELETED :: IndexState
- pattern IndexState_DELETING :: IndexState
- pattern IndexState_UPDATING :: IndexState
- newtype IndexType where
- IndexType' { }
- pattern IndexType_AGGREGATOR :: IndexType
- pattern IndexType_LOCAL :: IndexType
- data BatchGetViewError = BatchGetViewError' {
- errorMessage :: Text
- viewArn :: Text
- newBatchGetViewError :: Text -> Text -> BatchGetViewError
- batchGetViewError_errorMessage :: Lens' BatchGetViewError Text
- batchGetViewError_viewArn :: Lens' BatchGetViewError Text
- data Document = Document' {
- newDocument :: Document
- data IncludedProperty = IncludedProperty' {}
- newIncludedProperty :: Text -> IncludedProperty
- includedProperty_name :: Lens' IncludedProperty Text
- data Index = Index' {}
- newIndex :: Index
- index_arn :: Lens' Index (Maybe Text)
- index_region :: Lens' Index (Maybe Text)
- index_type :: Lens' Index (Maybe IndexType)
- data Resource = Resource' {
- arn :: Maybe Text
- lastReportedAt :: Maybe ISO8601
- owningAccountId :: Maybe Text
- properties :: Maybe [ResourceProperty]
- region :: Maybe Text
- resourceType :: Maybe Text
- service :: Maybe Text
- newResource :: Resource
- resource_arn :: Lens' Resource (Maybe Text)
- resource_lastReportedAt :: Lens' Resource (Maybe UTCTime)
- resource_owningAccountId :: Lens' Resource (Maybe Text)
- resource_properties :: Lens' Resource (Maybe [ResourceProperty])
- resource_region :: Lens' Resource (Maybe Text)
- resource_resourceType :: Lens' Resource (Maybe Text)
- resource_service :: Lens' Resource (Maybe Text)
- data ResourceCount = ResourceCount' {}
- newResourceCount :: ResourceCount
- resourceCount_complete :: Lens' ResourceCount (Maybe Bool)
- resourceCount_totalResources :: Lens' ResourceCount (Maybe Integer)
- data ResourceProperty = ResourceProperty' {}
- newResourceProperty :: ResourceProperty
- resourceProperty_data :: Lens' ResourceProperty (Maybe Document)
- resourceProperty_lastReportedAt :: Lens' ResourceProperty (Maybe UTCTime)
- resourceProperty_name :: Lens' ResourceProperty (Maybe Text)
- data SearchFilter = SearchFilter' {
- filterString :: Text
- newSearchFilter :: Text -> SearchFilter
- searchFilter_filterString :: Lens' SearchFilter Text
- data SupportedResourceType = SupportedResourceType' {}
- newSupportedResourceType :: SupportedResourceType
- supportedResourceType_resourceType :: Lens' SupportedResourceType (Maybe Text)
- supportedResourceType_service :: Lens' SupportedResourceType (Maybe Text)
- data View = View' {}
- newView :: View
- view_filters :: Lens' View (Maybe SearchFilter)
- view_includedProperties :: Lens' View (Maybe [IncludedProperty])
- view_lastUpdatedAt :: Lens' View (Maybe UTCTime)
- view_owner :: Lens' View (Maybe Text)
- view_scope :: Lens' View (Maybe Text)
- view_viewArn :: Lens' View (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2022-07-28 of the Amazon Resource Explorer SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The credentials that you used to call this operation don't have the minimum required permissions.
_ConflictException :: AsError a => Fold a ServiceError Source #
You tried to create a new view or index when one already exists, and you either didn't specify or specified a different idempotency token as the original request.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request failed because of internal service error. Try your request again later.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request failed because it exceeds a service quota.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
The principal making the request isn't permitted to perform the operation.
_ValidationException :: AsError a => Fold a ServiceError Source #
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
IndexState
newtype IndexState Source #
Constructors
| IndexState' | |
Fields | |
Bundled Patterns
| pattern IndexState_ACTIVE :: IndexState | |
| pattern IndexState_CREATING :: IndexState | |
| pattern IndexState_DELETED :: IndexState | |
| pattern IndexState_DELETING :: IndexState | |
| pattern IndexState_UPDATING :: IndexState |
Instances
IndexType
Constructors
| IndexType' | |
Fields | |
Bundled Patterns
| pattern IndexType_AGGREGATOR :: IndexType | |
| pattern IndexType_LOCAL :: IndexType |
Instances
BatchGetViewError
data BatchGetViewError Source #
A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.
See: newBatchGetViewError smart constructor.
Constructors
| BatchGetViewError' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> BatchGetViewError |
Create a value of BatchGetViewError 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:errorMessage:BatchGetViewError', batchGetViewError_errorMessage - The description of the error for the specified view.
$sel:viewArn:BatchGetViewError', batchGetViewError_viewArn - The
Amazon resource name (ARN)
of the view for which Resource Explorer failed to retrieve details.
batchGetViewError_errorMessage :: Lens' BatchGetViewError Text Source #
The description of the error for the specified view.
batchGetViewError_viewArn :: Lens' BatchGetViewError Text Source #
The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.
Document
See: newDocument smart constructor.
Constructors
| Document' | |
Instances
newDocument :: Document Source #
Create a value of Document with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
IncludedProperty
data IncludedProperty Source #
Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property.
See: newIncludedProperty smart constructor.
Constructors
| IncludedProperty' | |
Instances
Arguments
| :: Text | |
| -> IncludedProperty |
Create a value of IncludedProperty 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:name:IncludedProperty', includedProperty_name - The name of the property that is included in this view.
You can specify the following property names for this field:
Tags
includedProperty_name :: Lens' IncludedProperty Text Source #
The name of the property that is included in this view.
You can specify the following property names for this field:
Tags
Index
An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.
By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.
See: newIndex smart constructor.
Constructors
| Index' | |
Fields
| |
Instances
| FromJSON Index Source # | |
| Generic Index Source # | |
| Read Index Source # | |
| Show Index Source # | |
| NFData Index Source # | |
Defined in Amazonka.ResourceExplorer2.Types.Index | |
| Eq Index Source # | |
| Hashable Index Source # | |
Defined in Amazonka.ResourceExplorer2.Types.Index | |
| type Rep Index Source # | |
Defined in Amazonka.ResourceExplorer2.Types.Index type Rep Index = D1 ('MetaData "Index" "Amazonka.ResourceExplorer2.Types.Index" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "Index'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexType))))) | |
Create a value of Index 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:Index', index_arn - The
Amazon resource name (ARN)
of the index.
$sel:region:Index', index_region - The Amazon Web Services Region in which the index exists.
$sel:type':Index', index_type - The type of index. It can be one of the following values:
- LOCAL – The index contains information about resources from only the same Amazon Web Services Region.
- AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.
index_region :: Lens' Index (Maybe Text) Source #
The Amazon Web Services Region in which the index exists.
index_type :: Lens' Index (Maybe IndexType) Source #
The type of index. It can be one of the following values:
- LOCAL – The index contains information about resources from only the same Amazon Web Services Region.
- AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.
Resource
A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored information in the index of the Amazon Web Services Region that contains the resource.
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 resource name (ARN)
of the resource.
Resource, resource_lastReportedAt - The date and time that Resource Explorer last queried this resource and
updated the index with the latest information about the resource.
$sel:owningAccountId:Resource', resource_owningAccountId - The Amazon Web Services account that owns the resource.
$sel:properties:Resource', resource_properties - A structure with additional type-specific details about the resource.
These properties can be added by turning on integration between Resource
Explorer and other Amazon Web Services services.
$sel:region:Resource', resource_region - The Amazon Web Services Region in which the resource was created and
exists.
$sel:resourceType:Resource', resource_resourceType - The type of the resource.
$sel:service:Resource', resource_service - The Amazon Web Service that owns the resource and is responsible for
creating and updating it.
resource_arn :: Lens' Resource (Maybe Text) Source #
The Amazon resource name (ARN) of the resource.
resource_lastReportedAt :: Lens' Resource (Maybe UTCTime) Source #
The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.
resource_owningAccountId :: Lens' Resource (Maybe Text) Source #
The Amazon Web Services account that owns the resource.
resource_properties :: Lens' Resource (Maybe [ResourceProperty]) Source #
A structure with additional type-specific details about the resource. These properties can be added by turning on integration between Resource Explorer and other Amazon Web Services services.
resource_region :: Lens' Resource (Maybe Text) Source #
The Amazon Web Services Region in which the resource was created and exists.
resource_service :: Lens' Resource (Maybe Text) Source #
The Amazon Web Service that owns the resource and is responsible for creating and updating it.
ResourceCount
data ResourceCount Source #
Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for any query. This structure provides information about whether the query exceeded this limit.
This field is included in every page when you paginate the results.
See: newResourceCount smart constructor.
Constructors
| ResourceCount' | |
Fields
| |
Instances
newResourceCount :: ResourceCount Source #
Create a value of ResourceCount 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:complete:ResourceCount', resourceCount_complete - Indicates whether the TotalResources value represents an exhaustive
count of search results.
- If
True, it indicates that the search was exhaustive. Every resource that matches the query was counted. - If
False, then the search reached the limit of 1,000 matching results, and stopped counting.
$sel:totalResources:ResourceCount', resourceCount_totalResources - The number of resources that match the search query. This value can't
exceed 1,000. If there are more than 1,000 resources that match the
query, then only 1,000 are counted and the Complete field is set to
false. We recommend that you refine your query to return a smaller
number of results.
resourceCount_complete :: Lens' ResourceCount (Maybe Bool) Source #
Indicates whether the TotalResources value represents an exhaustive
count of search results.
- If
True, it indicates that the search was exhaustive. Every resource that matches the query was counted. - If
False, then the search reached the limit of 1,000 matching results, and stopped counting.
resourceCount_totalResources :: Lens' ResourceCount (Maybe Integer) Source #
The number of resources that match the search query. This value can't
exceed 1,000. If there are more than 1,000 resources that match the
query, then only 1,000 are counted and the Complete field is set to
false. We recommend that you refine your query to return a smaller
number of results.
ResourceProperty
data ResourceProperty Source #
A structure that describes a property of a resource.
See: newResourceProperty smart constructor.
Constructors
| ResourceProperty' | |
Fields
| |
Instances
newResourceProperty :: ResourceProperty Source #
Create a value of ResourceProperty 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:data':ResourceProperty', resourceProperty_data - Details about this property. The content of this field is a JSON object
that varies based on the resource type.
$sel:lastReportedAt:ResourceProperty', resourceProperty_lastReportedAt - The date and time that the information about this resource property was
last updated.
$sel:name:ResourceProperty', resourceProperty_name - The name of this property of the resource.
resourceProperty_data :: Lens' ResourceProperty (Maybe Document) Source #
Details about this property. The content of this field is a JSON object that varies based on the resource type.
resourceProperty_lastReportedAt :: Lens' ResourceProperty (Maybe UTCTime) Source #
The date and time that the information about this resource property was last updated.
resourceProperty_name :: Lens' ResourceProperty (Maybe Text) Source #
The name of this property of the resource.
SearchFilter
data SearchFilter Source #
A search filter defines which resources can be part of a search query result set.
See: newSearchFilter smart constructor.
Constructors
| SearchFilter' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SearchFilter |
Create a value of SearchFilter 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:filterString:SearchFilter', searchFilter_filterString - The string that contains the search keywords, prefixes, and operators to
control the results that can be returned by a Search operation. For more
details, see
Search query syntax.
searchFilter_filterString :: Lens' SearchFilter Text Source #
The string that contains the search keywords, prefixes, and operators to control the results that can be returned by a Search operation. For more details, see Search query syntax.
SupportedResourceType
data SupportedResourceType Source #
A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
See: newSupportedResourceType smart constructor.
Constructors
| SupportedResourceType' | |
Instances
newSupportedResourceType :: SupportedResourceType Source #
Create a value of SupportedResourceType 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:SupportedResourceType', supportedResourceType_resourceType - The unique identifier of the resource type.
$sel:service:SupportedResourceType', supportedResourceType_service - The Amazon Web Service that is associated with the resource type. This
is the primary service that lets you create and interact with resources
of this type.
supportedResourceType_resourceType :: Lens' SupportedResourceType (Maybe Text) Source #
The unique identifier of the resource type.
supportedResourceType_service :: Lens' SupportedResourceType (Maybe Text) Source #
The Amazon Web Service that is associated with the resource type. This is the primary service that lets you create and interact with resources of this type.
View
A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in the results returned by this view. You could also create a second view that includes only resources that are tagged with "ENV" and "PRODUCTION".
See: newView smart constructor.
Constructors
| View' | |
Fields
| |
Instances
Create a value of View 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:filters:View', view_filters - An array of SearchFilter objects that specify which resources can be
included in the results of queries made using this view.
$sel:includedProperties:View', view_includedProperties - A structure that contains additional information about the view.
$sel:lastUpdatedAt:View', view_lastUpdatedAt - The date and time when this view was last modified.
$sel:owner:View', view_owner - The Amazon Web Services account that owns this view.
$sel:scope:View', view_scope - An
Amazon resource name (ARN)
of an Amazon Web Services account, an organization, or an organizational
unit (OU) that specifies whether this view includes resources from only
the specified Amazon Web Services account, all accounts in the specified
organization, or all accounts in the specified OU.
If not specified, the value defaults to the Amazon Web Services account used to call this operation.
$sel:viewArn:View', view_viewArn - The
Amazon resource name (ARN)
of the view.
view_filters :: Lens' View (Maybe SearchFilter) Source #
An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
view_includedProperties :: Lens' View (Maybe [IncludedProperty]) Source #
A structure that contains additional information about the view.
view_lastUpdatedAt :: Lens' View (Maybe UTCTime) Source #
The date and time when this view was last modified.
view_scope :: Lens' View (Maybe Text) Source #
An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.
If not specified, the value defaults to the Amazon Web Services account used to call this operation.
view_viewArn :: Lens' View (Maybe Text) Source #
The Amazon resource name (ARN) of the view.