| 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
Description
Derived from API version 2022-07-28 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.
Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.
You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.
For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.
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
- data AssociateDefaultView = AssociateDefaultView' Text
- newAssociateDefaultView :: Text -> AssociateDefaultView
- data AssociateDefaultViewResponse = AssociateDefaultViewResponse' (Maybe Text) Int
- newAssociateDefaultViewResponse :: Int -> AssociateDefaultViewResponse
- data BatchGetView = BatchGetView' (Maybe (NonEmpty Text))
- newBatchGetView :: BatchGetView
- data BatchGetViewResponse = BatchGetViewResponse' (Maybe [BatchGetViewError]) (Maybe [View]) Int
- newBatchGetViewResponse :: Int -> BatchGetViewResponse
- data CreateIndex = CreateIndex' (Maybe Text) (Maybe (HashMap Text Text))
- newCreateIndex :: CreateIndex
- data CreateIndexResponse = CreateIndexResponse' (Maybe Text) (Maybe ISO8601) (Maybe IndexState) Int
- newCreateIndexResponse :: Int -> CreateIndexResponse
- data CreateView = CreateView' (Maybe Text) (Maybe (Sensitive SearchFilter)) (Maybe [IncludedProperty]) (Maybe (HashMap Text Text)) Text
- newCreateView :: Text -> CreateView
- data CreateViewResponse = CreateViewResponse' (Maybe View) Int
- newCreateViewResponse :: Int -> CreateViewResponse
- data DeleteIndex = DeleteIndex' Text
- newDeleteIndex :: Text -> DeleteIndex
- data DeleteIndexResponse = DeleteIndexResponse' (Maybe Text) (Maybe ISO8601) (Maybe IndexState) Int
- newDeleteIndexResponse :: Int -> DeleteIndexResponse
- data DeleteView = DeleteView' Text
- newDeleteView :: Text -> DeleteView
- data DeleteViewResponse = DeleteViewResponse' (Maybe Text) Int
- newDeleteViewResponse :: Int -> DeleteViewResponse
- data DisassociateDefaultView = DisassociateDefaultView' {
- newDisassociateDefaultView :: DisassociateDefaultView
- data DisassociateDefaultViewResponse = DisassociateDefaultViewResponse' {
- newDisassociateDefaultViewResponse :: DisassociateDefaultViewResponse
- data GetDefaultView = GetDefaultView' {
- newGetDefaultView :: GetDefaultView
- data GetDefaultViewResponse = GetDefaultViewResponse' (Maybe Text) Int
- newGetDefaultViewResponse :: Int -> GetDefaultViewResponse
- data GetIndex = GetIndex' {
- newGetIndex :: GetIndex
- data GetIndexResponse = GetIndexResponse' (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe [Text]) (Maybe [Text]) (Maybe IndexState) (Maybe (HashMap Text Text)) (Maybe IndexType) Int
- newGetIndexResponse :: Int -> GetIndexResponse
- data GetView = GetView' Text
- newGetView :: Text -> GetView
- data GetViewResponse = GetViewResponse' (Maybe (HashMap Text Text)) (Maybe View) Int
- newGetViewResponse :: Int -> GetViewResponse
- data ListIndexes = ListIndexes' (Maybe Natural) (Maybe Text) (Maybe [Text]) (Maybe IndexType)
- newListIndexes :: ListIndexes
- data ListIndexesResponse = ListIndexesResponse' (Maybe [Index]) (Maybe Text) Int
- newListIndexesResponse :: Int -> ListIndexesResponse
- data ListSupportedResourceTypes = ListSupportedResourceTypes' (Maybe Natural) (Maybe Text)
- newListSupportedResourceTypes :: ListSupportedResourceTypes
- data ListSupportedResourceTypesResponse = ListSupportedResourceTypesResponse' (Maybe Text) (Maybe [SupportedResourceType]) Int
- newListSupportedResourceTypesResponse :: Int -> ListSupportedResourceTypesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListViews = ListViews' (Maybe Natural) (Maybe Text)
- newListViews :: ListViews
- data ListViewsResponse = ListViewsResponse' (Maybe Text) (Maybe [Text]) Int
- newListViewsResponse :: Int -> ListViewsResponse
- data Search = Search' (Maybe Natural) (Maybe Text) (Maybe Text) (Sensitive Text)
- newSearch :: Text -> Search
- data SearchResponse = SearchResponse' (Maybe ResourceCount) (Maybe Text) (Maybe [Resource]) (Maybe Text) Int
- newSearchResponse :: Int -> SearchResponse
- data TagResource = TagResource' (Maybe (HashMap Text Text)) Text
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateIndexType = UpdateIndexType' Text IndexType
- newUpdateIndexType :: Text -> IndexType -> UpdateIndexType
- data UpdateIndexTypeResponse = UpdateIndexTypeResponse' (Maybe Text) (Maybe ISO8601) (Maybe IndexState) (Maybe IndexType) Int
- newUpdateIndexTypeResponse :: Int -> UpdateIndexTypeResponse
- data UpdateView = UpdateView' (Maybe (Sensitive SearchFilter)) (Maybe [IncludedProperty]) Text
- newUpdateView :: Text -> UpdateView
- data UpdateViewResponse = UpdateViewResponse' (Maybe View) Int
- newUpdateViewResponse :: Int -> UpdateViewResponse
- 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' Text Text
- newBatchGetViewError :: Text -> Text -> BatchGetViewError
- data Document = Document' {
- newDocument :: Document
- data IncludedProperty = IncludedProperty' Text
- newIncludedProperty :: Text -> IncludedProperty
- data Index = Index' (Maybe Text) (Maybe Text) (Maybe IndexType)
- newIndex :: Index
- data Resource = Resource' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [ResourceProperty]) (Maybe Text) (Maybe Text) (Maybe Text)
- newResource :: Resource
- data ResourceCount = ResourceCount' (Maybe Bool) (Maybe Integer)
- newResourceCount :: ResourceCount
- data ResourceProperty = ResourceProperty' (Maybe Document) (Maybe ISO8601) (Maybe Text)
- newResourceProperty :: ResourceProperty
- data SearchFilter = SearchFilter' Text
- newSearchFilter :: Text -> SearchFilter
- data SupportedResourceType = SupportedResourceType' (Maybe Text) (Maybe Text)
- newSupportedResourceType :: SupportedResourceType
- data View = View' (Maybe (Sensitive SearchFilter)) (Maybe [IncludedProperty]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text)
- newView :: View
Service Configuration
defaultService :: Service Source #
API version 2022-07-28 of the Amazon Resource Explorer 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 ResourceExplorer2.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The credentials that you used to call this operation don't have the minimum required permissions.
ConflictException
_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
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request failed because of internal service error. Try your request again later.
ResourceNotFoundException
_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
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request failed because it exceeds a service quota.
ThrottlingException
_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
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
The principal making the request isn't permitted to perform the operation.
ValidationException
_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.
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.
AssociateDefaultView
data AssociateDefaultView Source #
See: newAssociateDefaultView smart constructor.
Constructors
| AssociateDefaultView' Text |
Instances
newAssociateDefaultView Source #
Arguments
| :: Text | |
| -> AssociateDefaultView |
Create a value of AssociateDefaultView 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:
AssociateDefaultView, associateDefaultView_viewArn - The
Amazon resource name (ARN)
of the view to set as the default for the Amazon Web Services Region and
Amazon Web Services account in which you call this operation. The
specified view must already exist in the called Region.
data AssociateDefaultViewResponse Source #
See: newAssociateDefaultViewResponse smart constructor.
Constructors
| AssociateDefaultViewResponse' (Maybe Text) Int |
Instances
newAssociateDefaultViewResponse Source #
Create a value of AssociateDefaultViewResponse 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:
AssociateDefaultView, associateDefaultViewResponse_viewArn - The
Amazon resource name (ARN)
of the view that the operation set as the default for queries made in
the Amazon Web Services Region and Amazon Web Services account in which
you called this operation.
$sel:httpStatus:AssociateDefaultViewResponse', associateDefaultViewResponse_httpStatus - The response's http status code.
BatchGetView
data BatchGetView Source #
See: newBatchGetView smart constructor.
Constructors
| BatchGetView' (Maybe (NonEmpty Text)) |
Instances
newBatchGetView :: BatchGetView Source #
Create a value of BatchGetView 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:viewArns:BatchGetView', batchGetView_viewArns - A list of
Amazon resource names (ARNs)
that identify the views you want details for.
data BatchGetViewResponse Source #
See: newBatchGetViewResponse smart constructor.
Constructors
| BatchGetViewResponse' (Maybe [BatchGetViewError]) (Maybe [View]) Int |
Instances
newBatchGetViewResponse Source #
Arguments
| :: Int | |
| -> BatchGetViewResponse |
Create a value of BatchGetViewResponse 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:errors:BatchGetViewResponse', batchGetViewResponse_errors - If any of the specified ARNs result in an error, then this structure
describes the error.
$sel:views:BatchGetViewResponse', batchGetViewResponse_views - A structure with a list of objects with details for each of the
specified views.
$sel:httpStatus:BatchGetViewResponse', batchGetViewResponse_httpStatus - The response's http status code.
CreateIndex
data CreateIndex Source #
See: newCreateIndex smart constructor.
Instances
newCreateIndex :: CreateIndex Source #
Create a value of CreateIndex 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:CreateIndex', createIndex_clientToken - This value helps ensure idempotency. Resource Explorer uses this value
to prevent the accidental creation of duplicate versions. We recommend
that you generate a
UUID-type value
to ensure the uniqueness of your views.
$sel:tags:CreateIndex', createIndex_tags - The specified tags are attached only to the index created in this Amazon
Web Services Region. The tags aren't attached to any of the resources
listed in the index.
data CreateIndexResponse Source #
See: newCreateIndexResponse smart constructor.
Constructors
| CreateIndexResponse' (Maybe Text) (Maybe ISO8601) (Maybe IndexState) Int |
Instances
newCreateIndexResponse Source #
Arguments
| :: Int | |
| -> CreateIndexResponse |
Create a value of CreateIndexResponse 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:
CreateIndexResponse, createIndexResponse_arn - The ARN of the new local index for the Region. You can reference this
ARN in IAM permission policies to authorize the following operations:
DeleteIndex | GetIndex | UpdateIndexType | CreateView
$sel:createdAt:CreateIndexResponse', createIndexResponse_createdAt - The date and timestamp when the index was created.
$sel:state:CreateIndexResponse', createIndexResponse_state - Indicates the current state of the index. You can check for changes to
the state for asynchronous operations by calling the GetIndex operation.
The state can remain in the CREATING or UPDATING state for several
hours as Resource Explorer discovers the information about your
resources and populates the index.
$sel:httpStatus:CreateIndexResponse', createIndexResponse_httpStatus - The response's http status code.
CreateView
data CreateView Source #
See: newCreateView smart constructor.
Constructors
| CreateView' (Maybe Text) (Maybe (Sensitive SearchFilter)) (Maybe [IncludedProperty]) (Maybe (HashMap Text Text)) Text |
Instances
Arguments
| :: Text | |
| -> CreateView |
Create a value of CreateView 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:CreateView', createView_clientToken - This value helps ensure idempotency. Resource Explorer uses this value
to prevent the accidental creation of duplicate versions. We recommend
that you generate a
UUID-type value
to ensure the uniqueness of your views.
CreateView, createView_filters - An array of strings that specify which resources are included in the
results of queries made using this view. When you use this view in a
Search operation, the filter string is combined with the search's
QueryString parameter using a logical AND operator.
For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
This query string in the context of this operation supports only
filter prefixes
with optional
operators.
It doesn't support free-form text. For example, the string
region:us* service:ec2 -tag:stage=prod includes all Amazon EC2
resources in any Amazon Web Services Region that begins with the letters
us and is not tagged with a key Stage that has the value prod.
CreateView, createView_includedProperties - Specifies optional fields that you want included in search results from
this view. It is a list of objects that each describe a field to
include.
The default is an empty list, with no optional fields included in the results.
$sel:tags:CreateView', createView_tags - Tag key and value pairs that are attached to the view.
$sel:viewName:CreateView', createView_viewName - The name of the new view. This name appears in the list of views in
Resource Explorer.
The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.
data CreateViewResponse Source #
See: newCreateViewResponse smart constructor.
Constructors
| CreateViewResponse' (Maybe View) Int |
Instances
newCreateViewResponse Source #
Arguments
| :: Int | |
| -> CreateViewResponse |
Create a value of CreateViewResponse 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:view:CreateViewResponse', createViewResponse_view - A structure that contains the details about the new view.
$sel:httpStatus:CreateViewResponse', createViewResponse_httpStatus - The response's http status code.
DeleteIndex
data DeleteIndex Source #
See: newDeleteIndex smart constructor.
Constructors
| DeleteIndex' Text |
Instances
Arguments
| :: Text | |
| -> DeleteIndex |
Create a value of DeleteIndex 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:
DeleteIndex, deleteIndex_arn - The
Amazon resource name (ARN)
of the index that you want to delete.
data DeleteIndexResponse Source #
See: newDeleteIndexResponse smart constructor.
Constructors
| DeleteIndexResponse' (Maybe Text) (Maybe ISO8601) (Maybe IndexState) Int |
Instances
newDeleteIndexResponse Source #
Arguments
| :: Int | |
| -> DeleteIndexResponse |
Create a value of DeleteIndexResponse 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:
DeleteIndex, deleteIndexResponse_arn - The
Amazon resource name (ARN)
of the index that you successfully started the deletion process.
This operation is asynchronous. To check its status, call the GetIndex operation.
DeleteIndexResponse, deleteIndexResponse_lastUpdatedAt - The date and time when you last updated this index.
$sel:state:DeleteIndexResponse', deleteIndexResponse_state - Indicates the current state of the index.
$sel:httpStatus:DeleteIndexResponse', deleteIndexResponse_httpStatus - The response's http status code.
DeleteView
data DeleteView Source #
See: newDeleteView smart constructor.
Constructors
| DeleteView' Text |
Instances
Arguments
| :: Text | |
| -> DeleteView |
Create a value of DeleteView 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:
DeleteView, deleteView_viewArn - The
Amazon resource name (ARN)
of the view that you want to delete.
data DeleteViewResponse Source #
See: newDeleteViewResponse smart constructor.
Constructors
| DeleteViewResponse' (Maybe Text) Int |
Instances
newDeleteViewResponse Source #
Arguments
| :: Int | |
| -> DeleteViewResponse |
Create a value of DeleteViewResponse 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:
DeleteView, deleteViewResponse_viewArn - The
Amazon resource name (ARN)
of the view that you successfully deleted.
$sel:httpStatus:DeleteViewResponse', deleteViewResponse_httpStatus - The response's http status code.
DisassociateDefaultView
data DisassociateDefaultView Source #
See: newDisassociateDefaultView smart constructor.
Constructors
| DisassociateDefaultView' | |
Instances
newDisassociateDefaultView :: DisassociateDefaultView Source #
Create a value of DisassociateDefaultView with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DisassociateDefaultViewResponse Source #
See: newDisassociateDefaultViewResponse smart constructor.
Constructors
| DisassociateDefaultViewResponse' | |
Instances
| Generic DisassociateDefaultViewResponse Source # | |
Defined in Amazonka.ResourceExplorer2.DisassociateDefaultView Associated Types type Rep DisassociateDefaultViewResponse :: Type -> Type # | |
| Read DisassociateDefaultViewResponse Source # | |
| Show DisassociateDefaultViewResponse Source # | |
Defined in Amazonka.ResourceExplorer2.DisassociateDefaultView Methods showsPrec :: Int -> DisassociateDefaultViewResponse -> ShowS # | |
| NFData DisassociateDefaultViewResponse Source # | |
Defined in Amazonka.ResourceExplorer2.DisassociateDefaultView Methods rnf :: DisassociateDefaultViewResponse -> () # | |
| Eq DisassociateDefaultViewResponse Source # | |
| type Rep DisassociateDefaultViewResponse Source # | |
newDisassociateDefaultViewResponse :: DisassociateDefaultViewResponse Source #
Create a value of DisassociateDefaultViewResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetDefaultView
data GetDefaultView Source #
See: newGetDefaultView smart constructor.
Constructors
| GetDefaultView' | |
Instances
newGetDefaultView :: GetDefaultView Source #
Create a value of GetDefaultView with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetDefaultViewResponse Source #
See: newGetDefaultViewResponse smart constructor.
Constructors
| GetDefaultViewResponse' (Maybe Text) Int |
Instances
newGetDefaultViewResponse Source #
Create a value of GetDefaultViewResponse 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:
GetDefaultViewResponse, getDefaultViewResponse_viewArn - The
Amazon resource name (ARN)
of the view that is the current default for the Amazon Web Services
Region in which you called this operation.
$sel:httpStatus:GetDefaultViewResponse', getDefaultViewResponse_httpStatus - The response's http status code.
GetIndex
See: newGetIndex smart constructor.
Constructors
| GetIndex' | |
Instances
newGetIndex :: GetIndex Source #
Create a value of GetIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetIndexResponse Source #
See: newGetIndexResponse smart constructor.
Constructors
| GetIndexResponse' (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe [Text]) (Maybe [Text]) (Maybe IndexState) (Maybe (HashMap Text Text)) (Maybe IndexType) Int |
Instances
Arguments
| :: Int | |
| -> GetIndexResponse |
Create a value of GetIndexResponse 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:
GetIndexResponse, getIndexResponse_arn - The
Amazon resource name (ARN)
of the index.
$sel:createdAt:GetIndexResponse', getIndexResponse_createdAt - The date and time when the index was originally created.
GetIndexResponse, getIndexResponse_lastUpdatedAt - The date and time when the index was last updated.
$sel:replicatingFrom:GetIndexResponse', getIndexResponse_replicatingFrom - This response value is present only if this index is Type=AGGREGATOR.
A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
$sel:replicatingTo:GetIndexResponse', getIndexResponse_replicatingTo - This response value is present only if this index is Type=LOCAL.
The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
$sel:state:GetIndexResponse', getIndexResponse_state - The current state of the index in this Amazon Web Services Region.
$sel:tags:GetIndexResponse', getIndexResponse_tags - Tag key and value pairs that are attached to the index.
GetIndexResponse, getIndexResponse_type - The type of the index in this Region. For information about the
aggregator index and how it differs from a local index, see
Turning on cross-Region search by creating an aggregator index.
$sel:httpStatus:GetIndexResponse', getIndexResponse_httpStatus - The response's http status code.
GetView
See: newGetView smart constructor.
Instances
Create a value of GetView 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:
GetView, getView_viewArn - The
Amazon resource name (ARN)
of the view that you want information about.
data GetViewResponse Source #
See: newGetViewResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> GetViewResponse |
Create a value of GetViewResponse 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:tags:GetViewResponse', getViewResponse_tags - Tag key and value pairs that are attached to the view.
$sel:view:GetViewResponse', getViewResponse_view - A structure that contains the details for the requested view.
$sel:httpStatus:GetViewResponse', getViewResponse_httpStatus - The response's http status code.
ListIndexes (Paginated)
data ListIndexes Source #
See: newListIndexes smart constructor.
Instances
newListIndexes :: ListIndexes Source #
Create a value of ListIndexes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListIndexes', listIndexes_maxResults - The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those
included in the current response, the NextToken response element is
present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get
the next part of the results.
An API operation can return fewer results than the maximum even when
there are more results available. You should check NextToken after
every operation to ensure that you receive all of the results.
ListIndexes, listIndexes_nextToken - The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
$sel:regions:ListIndexes', listIndexes_regions - If specified, limits the response to only information about the index in
the specified list of Amazon Web Services Regions.
ListIndexes, listIndexes_type - If specified, limits the output to only indexes of the specified Type,
either LOCAL or AGGREGATOR.
Use this option to discover the aggregator index for your account.
data ListIndexesResponse Source #
See: newListIndexesResponse smart constructor.
Instances
newListIndexesResponse Source #
Arguments
| :: Int | |
| -> ListIndexesResponse |
Create a value of ListIndexesResponse 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:indexes:ListIndexesResponse', listIndexesResponse_indexes - A structure that contains the details and status of each index.
ListIndexes, listIndexesResponse_nextToken - If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
$sel:httpStatus:ListIndexesResponse', listIndexesResponse_httpStatus - The response's http status code.
ListSupportedResourceTypes (Paginated)
data ListSupportedResourceTypes Source #
See: newListSupportedResourceTypes smart constructor.
Constructors
| ListSupportedResourceTypes' (Maybe Natural) (Maybe Text) |
Instances
newListSupportedResourceTypes :: ListSupportedResourceTypes Source #
Create a value of ListSupportedResourceTypes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSupportedResourceTypes', listSupportedResourceTypes_maxResults - The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those
included in the current response, the NextToken response element is
present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get
the next part of the results.
An API operation can return fewer results than the maximum even when
there are more results available. You should check NextToken after
every operation to ensure that you receive all of the results.
ListSupportedResourceTypes, listSupportedResourceTypes_nextToken - The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
data ListSupportedResourceTypesResponse Source #
See: newListSupportedResourceTypesResponse smart constructor.
Constructors
| ListSupportedResourceTypesResponse' (Maybe Text) (Maybe [SupportedResourceType]) Int |
Instances
newListSupportedResourceTypesResponse Source #
Arguments
| :: Int | |
| -> ListSupportedResourceTypesResponse |
Create a value of ListSupportedResourceTypesResponse 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:
ListSupportedResourceTypes, listSupportedResourceTypesResponse_nextToken - If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
$sel:resourceTypes:ListSupportedResourceTypesResponse', listSupportedResourceTypesResponse_resourceTypes - The list of resource types supported by Resource Explorer.
$sel:httpStatus:ListSupportedResourceTypesResponse', listSupportedResourceTypesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The
Amazon resource name (ARN)
of the view or index that you want to attach tags to.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tag key and value pairs that you want to attach to the specified
view or index.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListViews (Paginated)
See: newListViews smart constructor.
Constructors
| ListViews' (Maybe Natural) (Maybe Text) |
Instances
newListViews :: ListViews Source #
Create a value of ListViews with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListViews', listViews_maxResults - The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those
included in the current response, the NextToken response element is
present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get
the next part of the results.
An API operation can return fewer results than the maximum even when
there are more results available. You should check NextToken after
every operation to ensure that you receive all of the results.
ListViews, listViews_nextToken - The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
data ListViewsResponse Source #
See: newListViewsResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListViewsResponse |
Create a value of ListViewsResponse 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:
ListViews, listViewsResponse_nextToken - If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
$sel:views:ListViewsResponse', listViewsResponse_views - The list of views available in the Amazon Web Services Region in which
you called this operation.
$sel:httpStatus:ListViewsResponse', listViewsResponse_httpStatus - The response's http status code.
Search (Paginated)
See: newSearch smart constructor.
Instances
Create a value of Search with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:Search', search_maxResults - The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those
included in the current response, the NextToken response element is
present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get
the next part of the results.
An API operation can return fewer results than the maximum even when
there are more results available. You should check NextToken after
every operation to ensure that you receive all of the results.
Search, search_nextToken - The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
Search, search_viewArn - Specifies the
Amazon resource name (ARN)
of the view to use for the query. If you don't specify a value for this
parameter, then the operation automatically uses the default view for
the Amazon Web Services Region in which you called this operation. If
the Region either doesn't have a default view or if you don't have
permission to use the default view, then the operation fails with a
401 Unauthorized exception.
$sel:queryString:Search', search_queryString - A string that includes keywords and filters that specify the resources
that you want to include in the results.
For the complete syntax supported by the QueryString parameter, see
Search query syntax reference for Resource Explorer.
The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.
The operation can return only the first 1,000 results. If the resource
you want is not included, then use a different value for QueryString
to refine the results.
data SearchResponse Source #
See: newSearchResponse smart constructor.
Constructors
| SearchResponse' (Maybe ResourceCount) (Maybe Text) (Maybe [Resource]) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> SearchResponse |
Create a value of SearchResponse 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:count:SearchResponse', searchResponse_count - The number of resources that match the query.
Search, searchResponse_nextToken - If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
$sel:resources:SearchResponse', searchResponse_resources - The list of structures that describe the resources that match the query.
Search, searchResponse_viewArn - The
Amazon resource name (ARN)
of the view that this operation used to perform the search.
$sel:httpStatus:SearchResponse', searchResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Instances
Arguments
| :: Text | |
| -> TagResource |
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:tags:TagResource', tagResource_tags - A list of tag key and value pairs that you want to attach to the
specified view or index.
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the view or index that you want to
attach tags to.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the view or index that you want to
remove tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of the keys for the tags that you want to remove from the
specified view or index.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
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.
UpdateIndexType
data UpdateIndexType Source #
See: newUpdateIndexType smart constructor.
Constructors
| UpdateIndexType' Text IndexType |
Instances
Arguments
| :: Text | |
| -> IndexType | |
| -> UpdateIndexType |
Create a value of UpdateIndexType 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:
UpdateIndexType, updateIndexType_arn - The
Amazon resource name (ARN)
of the index that you want to update.
UpdateIndexType, updateIndexType_type - The type of the index. To understand the difference between LOCAL and
AGGREGATOR, see
Turning on cross-Region search
in the Amazon Web Services Resource Explorer User Guide.
data UpdateIndexTypeResponse Source #
See: newUpdateIndexTypeResponse smart constructor.
Constructors
| UpdateIndexTypeResponse' (Maybe Text) (Maybe ISO8601) (Maybe IndexState) (Maybe IndexType) Int |
Instances
newUpdateIndexTypeResponse Source #
Create a value of UpdateIndexTypeResponse 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:
UpdateIndexType, updateIndexTypeResponse_arn - The
Amazon resource name (ARN)
of the index that you updated.
UpdateIndexTypeResponse, updateIndexTypeResponse_lastUpdatedAt - The date and timestamp when the index was last updated.
$sel:state:UpdateIndexTypeResponse', updateIndexTypeResponse_state - Indicates the state of the request to update the index. This operation
is asynchronous. Call the GetIndex operation to check for changes.
UpdateIndexType, updateIndexTypeResponse_type - Specifies the type of the specified index after the operation completes.
$sel:httpStatus:UpdateIndexTypeResponse', updateIndexTypeResponse_httpStatus - The response's http status code.
UpdateView
data UpdateView Source #
See: newUpdateView smart constructor.
Constructors
| UpdateView' (Maybe (Sensitive SearchFilter)) (Maybe [IncludedProperty]) Text |
Instances
Arguments
| :: Text | |
| -> UpdateView |
Create a value of UpdateView 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:
UpdateView, updateView_filters - An array of strings that specify which resources are included in the
results of queries made using this view. When you use this view in a
Search operation, the filter string is combined with the search's
QueryString parameter using a logical AND operator.
For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.
This query string in the context of this operation supports only
filter prefixes
with optional
operators.
It doesn't support free-form text. For example, the string
region:us* service:ec2 -tag:stage=prod includes all Amazon EC2
resources in any Amazon Web Services Region that begins with the letters
us and is not tagged with a key Stage that has the value prod.
UpdateView, updateView_includedProperties - Specifies optional fields that you want included in search results from
this view. It is a list of objects that each describe a field to
include.
The default is an empty list, with no optional fields included in the results.
UpdateView, updateView_viewArn - The
Amazon resource name (ARN)
of the view that you want to modify.
data UpdateViewResponse Source #
See: newUpdateViewResponse smart constructor.
Constructors
| UpdateViewResponse' (Maybe View) Int |
Instances
newUpdateViewResponse Source #
Arguments
| :: Int | |
| -> UpdateViewResponse |
Create a value of UpdateViewResponse 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:view:UpdateViewResponse', updateViewResponse_view - Details about the view that you changed with this operation.
$sel:httpStatus:UpdateViewResponse', updateViewResponse_httpStatus - The response's http status code.
Types
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' Text Text |
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.
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' Text |
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
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.
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.
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' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe [ResourceProperty]) (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: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.
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' (Maybe Bool) (Maybe Integer) |
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.
ResourceProperty
data ResourceProperty Source #
A structure that describes a property of a resource.
See: newResourceProperty smart constructor.
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.
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' Text |
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.
SupportedResourceType
data SupportedResourceType Source #
A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
See: newSupportedResourceType smart constructor.
Constructors
| SupportedResourceType' (Maybe Text) (Maybe Text) |
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.
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' (Maybe (Sensitive SearchFilter)) (Maybe [IncludedProperty]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) |
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.