amazonka-resource-explorer-v2-2.0: Amazon Resource Explorer SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ResourceExplorer2.Lens

Description

 
Synopsis

Operations

AssociateDefaultView

associateDefaultView_viewArn :: Lens' AssociateDefaultView Text Source #

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.

associateDefaultViewResponse_viewArn :: Lens' AssociateDefaultViewResponse (Maybe Text) Source #

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.

BatchGetView

batchGetView_viewArns :: Lens' BatchGetView (Maybe (NonEmpty Text)) Source #

A list of Amazon resource names (ARNs) that identify the views you want details for.

batchGetViewResponse_errors :: Lens' BatchGetViewResponse (Maybe [BatchGetViewError]) Source #

If any of the specified ARNs result in an error, then this structure describes the error.

batchGetViewResponse_views :: Lens' BatchGetViewResponse (Maybe [View]) Source #

A structure with a list of objects with details for each of the specified views.

CreateIndex

createIndex_clientToken :: Lens' CreateIndex (Maybe Text) Source #

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.

createIndex_tags :: Lens' CreateIndex (Maybe (HashMap Text Text)) Source #

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.

createIndexResponse_arn :: Lens' CreateIndexResponse (Maybe Text) Source #

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

createIndexResponse_createdAt :: Lens' CreateIndexResponse (Maybe UTCTime) Source #

The date and timestamp when the index was created.

createIndexResponse_state :: Lens' CreateIndexResponse (Maybe IndexState) Source #

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.

CreateView

createView_clientToken :: Lens' CreateView (Maybe Text) Source #

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_filters :: Lens' CreateView (Maybe SearchFilter) Source #

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_includedProperties :: Lens' CreateView (Maybe [IncludedProperty]) Source #

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.

createView_tags :: Lens' CreateView (Maybe (HashMap Text Text)) Source #

Tag key and value pairs that are attached to the view.

createView_viewName :: Lens' CreateView Text Source #

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.

createViewResponse_view :: Lens' CreateViewResponse (Maybe View) Source #

A structure that contains the details about the new view.

DeleteIndex

deleteIndex_arn :: Lens' DeleteIndex Text Source #

The Amazon resource name (ARN) of the index that you want to delete.

deleteIndexResponse_arn :: Lens' DeleteIndexResponse (Maybe Text) Source #

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_lastUpdatedAt :: Lens' DeleteIndexResponse (Maybe UTCTime) Source #

The date and time when you last updated this index.

deleteIndexResponse_state :: Lens' DeleteIndexResponse (Maybe IndexState) Source #

Indicates the current state of the index.

DeleteView

deleteView_viewArn :: Lens' DeleteView Text Source #

The Amazon resource name (ARN) of the view that you want to delete.

DisassociateDefaultView

GetDefaultView

getDefaultViewResponse_viewArn :: Lens' GetDefaultViewResponse (Maybe Text) Source #

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.

GetIndex

getIndexResponse_createdAt :: Lens' GetIndexResponse (Maybe UTCTime) Source #

The date and time when the index was originally created.

getIndexResponse_lastUpdatedAt :: Lens' GetIndexResponse (Maybe UTCTime) Source #

The date and time when the index was last updated.

getIndexResponse_replicatingFrom :: Lens' GetIndexResponse (Maybe [Text]) Source #

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.

getIndexResponse_replicatingTo :: Lens' GetIndexResponse (Maybe [Text]) Source #

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.

getIndexResponse_state :: Lens' GetIndexResponse (Maybe IndexState) Source #

The current state of the index in this Amazon Web Services Region.

getIndexResponse_tags :: Lens' GetIndexResponse (Maybe (HashMap Text Text)) Source #

Tag key and value pairs that are attached to the index.

getIndexResponse_type :: Lens' GetIndexResponse (Maybe IndexType) Source #

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.

getIndexResponse_httpStatus :: Lens' GetIndexResponse Int Source #

The response's http status code.

GetView

getView_viewArn :: Lens' GetView Text Source #

The Amazon resource name (ARN) of the view that you want information about.

getViewResponse_tags :: Lens' GetViewResponse (Maybe (HashMap Text Text)) Source #

Tag key and value pairs that are attached to the view.

getViewResponse_view :: Lens' GetViewResponse (Maybe View) Source #

A structure that contains the details for the requested view.

getViewResponse_httpStatus :: Lens' GetViewResponse Int Source #

The response's http status code.

ListIndexes

listIndexes_maxResults :: Lens' ListIndexes (Maybe Natural) Source #

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_nextToken :: Lens' ListIndexes (Maybe Text) Source #

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.

listIndexes_regions :: Lens' ListIndexes (Maybe [Text]) Source #

If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

listIndexes_type :: Lens' ListIndexes (Maybe IndexType) Source #

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.

listIndexesResponse_indexes :: Lens' ListIndexesResponse (Maybe [Index]) Source #

A structure that contains the details and status of each index.

listIndexesResponse_nextToken :: Lens' ListIndexesResponse (Maybe Text) Source #

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.

ListSupportedResourceTypes

listSupportedResourceTypes_maxResults :: Lens' ListSupportedResourceTypes (Maybe Natural) Source #

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_nextToken :: Lens' ListSupportedResourceTypes (Maybe Text) Source #

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.

listSupportedResourceTypesResponse_nextToken :: Lens' ListSupportedResourceTypesResponse (Maybe Text) Source #

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.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon resource name (ARN) of the view or index that you want to attach tags to.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The tag key and value pairs that you want to attach to the specified view or index.

ListViews

listViews_maxResults :: Lens' ListViews (Maybe Natural) Source #

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_nextToken :: Lens' ListViews (Maybe Text) Source #

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.

listViewsResponse_nextToken :: Lens' ListViewsResponse (Maybe Text) Source #

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.

listViewsResponse_views :: Lens' ListViewsResponse (Maybe [Text]) Source #

The list of views available in the Amazon Web Services Region in which you called this operation.

listViewsResponse_httpStatus :: Lens' ListViewsResponse Int Source #

The response's http status code.

Search

search_maxResults :: Lens' Search (Maybe Natural) Source #

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_nextToken :: Lens' Search (Maybe Text) Source #

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_viewArn :: Lens' Search (Maybe Text) Source #

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.

search_queryString :: Lens' Search Text Source #

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.

searchResponse_count :: Lens' SearchResponse (Maybe ResourceCount) Source #

The number of resources that match the query.

searchResponse_nextToken :: Lens' SearchResponse (Maybe Text) Source #

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.

searchResponse_resources :: Lens' SearchResponse (Maybe [Resource]) Source #

The list of structures that describe the resources that match the query.

searchResponse_viewArn :: Lens' SearchResponse (Maybe Text) Source #

The Amazon resource name (ARN) of the view that this operation used to perform the search.

searchResponse_httpStatus :: Lens' SearchResponse Int Source #

The response's http status code.

TagResource

tagResource_tags :: Lens' TagResource (Maybe (HashMap Text Text)) Source #

A list of tag key and value pairs that you want to attach to the specified view or index.

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of the keys for the tags that you want to remove from the specified view or index.

UpdateIndexType

updateIndexType_type :: Lens' UpdateIndexType IndexType Source #

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.

updateIndexTypeResponse_lastUpdatedAt :: Lens' UpdateIndexTypeResponse (Maybe UTCTime) Source #

The date and timestamp when the index was last updated.

updateIndexTypeResponse_state :: Lens' UpdateIndexTypeResponse (Maybe IndexState) Source #

Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.

updateIndexTypeResponse_type :: Lens' UpdateIndexTypeResponse (Maybe IndexType) Source #

Specifies the type of the specified index after the operation completes.

UpdateView

updateView_filters :: Lens' UpdateView (Maybe SearchFilter) Source #

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_includedProperties :: Lens' UpdateView (Maybe [IncludedProperty]) Source #

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_viewArn :: Lens' UpdateView Text Source #

The Amazon resource name (ARN) of the view that you want to modify.

updateViewResponse_view :: Lens' UpdateViewResponse (Maybe View) Source #

Details about the view that you changed with this operation.

Types

BatchGetViewError

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

IncludedProperty

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

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

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_resourceType :: Lens' Resource (Maybe Text) Source #

The type of the resource.

resource_service :: Lens' Resource (Maybe Text) Source #

The Amazon Web Service that owns the resource and is responsible for creating and updating it.

ResourceCount

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

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

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

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

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_owner :: Lens' View (Maybe Text) Source #

The Amazon Web Services account that owns this view.

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.