Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.
If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.
Retrieves details about a list of views.
", "readonly":true }, "CreateIndex":{ "name":"CreateIndex", "http":{ "method":"POST", "requestUri":"/CreateIndex", "responseCode":200 }, "input":{"shape":"CreateIndexInput"}, "output":{"shape":"CreateIndexOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide.
If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.
Action: resource-explorer-2:CreateIndex
Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account.
\"Resource\": \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"
Alternatively, you can use \"Resource\": \"*\" to allow the role or user to create an index in any Region.
Action: iam:CreateServiceLinkedRole
Resource: No specific resource (*).
This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.
Creates a Resource Explorer setup configuration across multiple Amazon Web Services Regions. This operation sets up indexes and views in the specified Regions. This operation can also be used to set an aggregator Region for cross-Region resource search.
", "idempotent":true }, "CreateView":{ "name":"CreateView", "http":{ "method":"POST", "requestUri":"/CreateView", "responseCode":200 }, "input":{"shape":"CreateViewInput"}, "output":{"shape":"CreateViewOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Creates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value.
If the index you delete is the aggregator index for the Amazon Web Services account, you must wait 24 hours before you can promote another local index to be the aggregator index for the account. Users can't perform account-wide searches using Resource Explorer until another aggregator index is configured.
Deletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.
", "idempotent":true }, "DeleteView":{ "name":"DeleteView", "http":{ "method":"POST", "requestUri":"/DeleteView", "responseCode":200 }, "input":{"shape":"DeleteViewInput"}, "output":{"shape":"DeleteViewOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes the specified view.
If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.
", "idempotent":true }, "DisassociateDefaultView":{ "name":"DisassociateDefaultView", "http":{ "method":"POST", "requestUri":"/DisassociateDefaultView", "responseCode":200 }, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.
If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.
Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account can invoke this API call.
", "readonly":true }, "GetDefaultView":{ "name":"GetDefaultView", "http":{ "method":"POST", "requestUri":"/GetDefaultView", "responseCode":200 }, "output":{"shape":"GetDefaultViewOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.
", "readonly":true }, "GetIndex":{ "name":"GetIndex", "http":{ "method":"POST", "requestUri":"/GetIndex", "responseCode":200 }, "output":{"shape":"GetIndexOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
" }, "GetManagedView":{ "name":"GetManagedView", "http":{ "method":"POST", "requestUri":"/GetManagedView", "responseCode":200 }, "input":{"shape":"GetManagedViewInput"}, "output":{"shape":"GetManagedViewOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves details of the specified Amazon Web Services-managed view.
", "readonly":true }, "GetResourceExplorerSetup":{ "name":"GetResourceExplorerSetup", "http":{ "method":"POST", "requestUri":"/GetResourceExplorerSetup", "responseCode":200 }, "input":{"shape":"GetResourceExplorerSetupInput"}, "output":{"shape":"GetResourceExplorerSetupOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting Resource Explorer configurations across Regions.
", "readonly":true }, "GetServiceIndex":{ "name":"GetServiceIndex", "http":{ "method":"POST", "requestUri":"/GetServiceIndex", "responseCode":200 }, "output":{"shape":"GetServiceIndexOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves information about the Resource Explorer index in the current Amazon Web Services Region. This operation returns the ARN and type of the index if one exists.
", "readonly":true }, "GetServiceView":{ "name":"GetServiceView", "http":{ "method":"POST", "requestUri":"/GetServiceView", "responseCode":200 }, "input":{"shape":"GetServiceViewInput"}, "output":{"shape":"GetServiceViewOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.
", "readonly":true }, "GetView":{ "name":"GetView", "http":{ "method":"POST", "requestUri":"/GetView", "responseCode":200 }, "input":{"shape":"GetViewInput"}, "output":{"shape":"GetViewOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves details of the specified view.
", "readonly":true }, "ListIndexes":{ "name":"ListIndexes", "http":{ "method":"POST", "requestUri":"/ListIndexes", "responseCode":200 }, "input":{"shape":"ListIndexesInput"}, "output":{"shape":"ListIndexesOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
", "readonly":true }, "ListIndexesForMembers":{ "name":"ListIndexesForMembers", "http":{ "method":"POST", "requestUri":"/ListIndexesForMembers", "responseCode":200 }, "input":{"shape":"ListIndexesForMembersInput"}, "output":{"shape":"ListIndexesForMembersOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.
", "readonly":true }, "ListManagedViews":{ "name":"ListManagedViews", "http":{ "method":"POST", "requestUri":"/ListManagedViews", "responseCode":200 }, "input":{"shape":"ListManagedViewsInput"}, "output":{"shape":"ListManagedViewsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists the Amazon resource names (ARNs) of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation.
" }, "ListResources":{ "name":"ListResources", "http":{ "method":"POST", "requestUri":"/ListResources", "responseCode":200 }, "input":{"shape":"ListResourcesInput"}, "output":{"shape":"ListResourcesOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
", "readonly":true }, "ListServiceIndexes":{ "name":"ListServiceIndexes", "http":{ "method":"POST", "requestUri":"/ListServiceIndexes", "responseCode":200 }, "input":{"shape":"ListServiceIndexesInput"}, "output":{"shape":"ListServiceIndexesOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs, types, and Regions.
", "readonly":true }, "ListServiceViews":{ "name":"ListServiceViews", "http":{ "method":"POST", "requestUri":"/ListServiceViews", "responseCode":200 }, "input":{"shape":"ListServiceViewsInput"}, "output":{"shape":"ListServiceViewsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists all Resource Explorer service views available in the current Amazon Web Services account. This operation returns the ARNs of available service views.
", "readonly":true }, "ListStreamingAccessForServices":{ "name":"ListStreamingAccessForServices", "http":{ "method":"POST", "requestUri":"/ListStreamingAccessForServices", "responseCode":200 }, "input":{"shape":"ListStreamingAccessForServicesInput"}, "output":{"shape":"ListStreamingAccessForServicesOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns a list of Amazon Web Services services that have been granted streaming access to your Resource Explorer data. Streaming access allows Amazon Web Services services to receive real-time updates about your resources as they are indexed by Resource Explorer.
" }, "ListSupportedResourceTypes":{ "name":"ListSupportedResourceTypes", "http":{ "method":"POST", "requestUri":"/ListSupportedResourceTypes", "responseCode":200 }, "input":{"shape":"ListSupportedResourceTypesInput"}, "output":{"shape":"ListSupportedResourceTypesOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists the tags that are attached to the specified resource.
", "readonly":true }, "ListViews":{ "name":"ListViews", "http":{ "method":"POST", "requestUri":"/ListViews", "responseCode":200 }, "input":{"shape":"ListViewsInput"}, "output":{"shape":"ListViewsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation.
Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.
Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.
All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.
For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.
", "readonly":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceInput"}, "output":{"shape":"TagResourceOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceInput"}, "output":{"shape":"UntagResourceOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
" }, "UpdateIndexType":{ "name":"UpdateIndexType", "http":{ "method":"POST", "requestUri":"/UpdateIndexType", "responseCode":200 }, "input":{"shape":"UpdateIndexTypeInput"}, "output":{"shape":"UpdateIndexTypeOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
AGGREGATOR index type
The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.
When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.
LOCAL index type
The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.
When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.
After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.
Modifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view.
" } }, "shapes":{ "AWSServiceAccessStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The credentials that you used to call this operation don't have the minimum required permissions.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccountId":{ "type":"string", "max":2048, "min":1 }, "AssociateDefaultViewInput":{ "type":"structure", "required":["ViewArn"], "members":{ "ViewArn":{ "shape":"AssociateDefaultViewInputViewArnString", "documentation":"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.
" } } }, "AssociateDefaultViewInputViewArnString":{ "type":"string", "max":1011, "min":1 }, "AssociateDefaultViewOutput":{ "type":"structure", "members":{ "ViewArn":{ "shape":"String", "documentation":"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.
" } } }, "BatchGetViewError":{ "type":"structure", "required":[ "ViewArn", "ErrorMessage" ], "members":{ "ViewArn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.
" }, "ErrorMessage":{ "shape":"String", "documentation":"The description of the error for the specified view.
" } }, "documentation":"A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.
" }, "BatchGetViewErrors":{ "type":"list", "member":{"shape":"BatchGetViewError"} }, "BatchGetViewInput":{ "type":"structure", "members":{ "ViewArns":{ "shape":"BatchGetViewInputViewArnsList", "documentation":"A list of Amazon resource names (ARNs) that identify the views you want details for.
" } } }, "BatchGetViewInputViewArnsList":{ "type":"list", "member":{"shape":"String"}, "max":20, "min":1 }, "BatchGetViewOutput":{ "type":"structure", "members":{ "Views":{ "shape":"ViewList", "documentation":"A structure with a list of objects with details for each of the specified views.
" }, "Errors":{ "shape":"BatchGetViewErrors", "documentation":"If any of the specified ARNs result in an error, then this structure describes the error.
" } } }, "Boolean":{ "type":"boolean", "box":true }, "ConflictException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region.
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 index.
", "idempotencyToken":true }, "Tags":{ "shape":"TagMap", "documentation":"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.
" } } }, "CreateIndexOutput":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"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
" }, "State":{ "shape":"IndexState", "documentation":"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.
The date and timestamp when the index was created.
" } } }, "CreateResourceExplorerSetupInput":{ "type":"structure", "required":[ "RegionList", "ViewName" ], "members":{ "RegionList":{ "shape":"CreateResourceExplorerSetupInputRegionListList", "documentation":"A list of Amazon Web Services Regions where Resource Explorer should be configured. Each Region in the list will have a user-owned index created.
" }, "AggregatorRegions":{ "shape":"CreateResourceExplorerSetupInputAggregatorRegionsList", "documentation":"A list of Amazon Web Services Regions that should be configured as aggregator Regions. Aggregator Regions receive replicated index information from all other Regions where there is a user-owned index.
" }, "ViewName":{ "shape":"CreateResourceExplorerSetupInputViewNameString", "documentation":"The name for the view to be created as part of the Resource Explorer setup. The view name must be unique within the Amazon Web Services account and Region.
" } } }, "CreateResourceExplorerSetupInputAggregatorRegionsList":{ "type":"list", "member":{"shape":"CreateResourceExplorerSetupInputAggregatorRegionsListMemberString"}, "max":1, "min":0 }, "CreateResourceExplorerSetupInputAggregatorRegionsListMemberString":{ "type":"string", "pattern":"[a-z-]+-[a-z]+-[0-9]" }, "CreateResourceExplorerSetupInputRegionListList":{ "type":"list", "member":{"shape":"CreateResourceExplorerSetupInputRegionListListMemberString"}, "min":1 }, "CreateResourceExplorerSetupInputRegionListListMemberString":{ "type":"string", "pattern":"[a-z-]+-[a-z]+-[0-9]" }, "CreateResourceExplorerSetupInputViewNameString":{ "type":"string", "pattern":"[a-zA-Z0-9-]{1,64}" }, "CreateResourceExplorerSetupOutput":{ "type":"structure", "required":["TaskId"], "members":{ "TaskId":{ "shape":"CreateResourceExplorerSetupOutputTaskIdString", "documentation":"The unique identifier for the setup task. Use this ID with GetResourceExplorerSetup to monitor the progress of the configuration operation.
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.
", "idempotencyToken":true }, "ViewName":{ "shape":"ViewName", "documentation":"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.
" }, "IncludedProperties":{ "shape":"IncludedPropertyList", "documentation":"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.
" }, "Scope":{ "shape":"CreateViewInputScopeString", "documentation":"The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
" }, "Filters":{ "shape":"SearchFilter", "documentation":"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.
Tag key and value pairs that are attached to the view.
" } } }, "CreateViewInputClientTokenString":{ "type":"string", "max":2048, "min":1 }, "CreateViewInputScopeString":{ "type":"string", "max":2048, "min":1 }, "CreateViewOutput":{ "type":"structure", "members":{ "View":{ "shape":"View", "documentation":"A structure that contains the details about the new view.
" } } }, "DeleteIndexInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the index that you want to delete.
" } } }, "DeleteIndexOutput":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"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.
Indicates the current state of the index.
" }, "LastUpdatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when you last updated this index.
" } } }, "DeleteResourceExplorerSetupInput":{ "type":"structure", "members":{ "RegionList":{ "shape":"RegionList", "documentation":"A list of Amazon Web Services Regions from which to delete the Resource Explorer configuration. If not specified, the operation uses the DeleteInAllRegions parameter to determine scope.
Specifies whether to delete Resource Explorer configuration from all Regions where it is currently enabled. If this parameter is set to true, a value for RegionList must not be provided. Otherwise, the operation fails with a ValidationException error.
The unique identifier for the deletion task. Use this ID with GetResourceExplorerSetup to monitor the progress of the deletion operation.
The Amazon resource name (ARN) of the view that you want to delete.
" } } }, "DeleteViewInputViewArnString":{ "type":"string", "max":1011, "min":1 }, "DeleteViewOutput":{ "type":"structure", "members":{ "ViewArn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the view that you successfully deleted.
" } } }, "Document":{ "type":"structure", "members":{}, "document":true }, "ErrorDetails":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"The error code that identifies the type of error that occurred.
" }, "Message":{ "shape":"String", "documentation":"A human-readable description of the error that occurred.
" } }, "documentation":"Contains information about an error that occurred during a Resource Explorer setup operation.
" }, "GetAccountLevelServiceConfigurationOutput":{ "type":"structure", "members":{ "OrgConfiguration":{ "shape":"OrgConfiguration", "documentation":"Details about the organization, and whether configuration is ENABLED or DISABLED.
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.
" } } }, "GetIndexOutput":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the index.
" }, "Type":{ "shape":"IndexType", "documentation":"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.
" }, "State":{ "shape":"IndexState", "documentation":"The current state of the index in this Amazon Web Services Region.
" }, "ReplicatingFrom":{ "shape":"RegionList", "documentation":"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.
" }, "ReplicatingTo":{ "shape":"RegionList", "documentation":"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.
" }, "CreatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when the index was originally created.
" }, "LastUpdatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when the index was last updated.
" }, "Tags":{ "shape":"TagMap", "documentation":"Tag key and value pairs that are attached to the index.
" } } }, "GetManagedViewInput":{ "type":"structure", "required":["ManagedViewArn"], "members":{ "ManagedViewArn":{ "shape":"GetManagedViewInputManagedViewArnString", "documentation":"The Amazon resource name (ARN) of the managed view.
" } } }, "GetManagedViewInputManagedViewArnString":{ "type":"string", "max":1011, "min":1 }, "GetManagedViewOutput":{ "type":"structure", "members":{ "ManagedView":{ "shape":"ManagedView", "documentation":"Details about the specified managed view.
" } } }, "GetResourceExplorerSetupInput":{ "type":"structure", "required":["TaskId"], "members":{ "TaskId":{ "shape":"GetResourceExplorerSetupInputTaskIdString", "documentation":"The unique identifier of the setup task to retrieve status information for. This ID is returned by CreateResourceExplorerSetup or DeleteResourceExplorerSetup operations.
The maximum number of Region status results to return in a single response. Valid values are between 1 and 100.
The pagination token from a previous GetResourceExplorerSetup response. Use this token to retrieve the next set of results.
A list of Region status objects that describe the current state of Resource Explorer configuration in each Region.
" }, "NextToken":{ "shape":"GetResourceExplorerSetupOutputNextTokenString", "documentation":"The pagination token to use in a subsequent GetResourceExplorerSetup request to retrieve the next set of results.
The Amazon Resource Name (ARN) of the Resource Explorer index in the current Region.
" }, "Type":{ "shape":"IndexType", "documentation":"The type of the index. Valid values are LOCAL (contains resources from the current Region only) or AGGREGATOR (contains replicated resource information from all Regions).
The Amazon Resource Name (ARN) of the service view to retrieve details for.
" } } }, "GetServiceViewInputServiceViewArnString":{ "type":"string", "max":1011, "min":1 }, "GetServiceViewOutput":{ "type":"structure", "required":["View"], "members":{ "View":{ "shape":"ServiceView", "documentation":"A ServiceView object that contains the details and configuration of the requested service view.
The Amazon resource name (ARN) of the view that you want information about.
" } } }, "GetViewInputViewArnString":{ "type":"string", "max":1011, "min":1 }, "GetViewOutput":{ "type":"structure", "members":{ "View":{ "shape":"View", "documentation":"A structure that contains the details for the requested view.
" }, "Tags":{ "shape":"TagMap", "documentation":"Tag key and value pairs that are attached to the view.
" } } }, "IncludedProperty":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"IncludedPropertyNameString", "documentation":"The name of the property that is included in this view.
You can specify the following property names for this field:
tags
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.
" }, "IncludedPropertyList":{ "type":"list", "member":{"shape":"IncludedProperty"} }, "IncludedPropertyNameString":{ "type":"string", "max":1011, "min":1 }, "Index":{ "type":"structure", "members":{ "Region":{ "shape":"String", "documentation":"The Amazon Web Services Region in which the index exists.
" }, "Arn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the index.
" }, "Type":{ "shape":"IndexType", "documentation":"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.
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.
" }, "IndexList":{ "type":"list", "member":{"shape":"Index"} }, "IndexState":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING" ] }, "IndexStatus":{ "type":"structure", "members":{ "Status":{ "shape":"OperationStatus", "documentation":"The current status of the index operation. Valid values are SUCCEEDED, FAILED, IN_PROGRESS, or SKIPPED.
Details about any error that occurred during the index operation.
" } }, "documentation":"Contains information about the status of a Resource Explorer index operation in a specific Region.
" }, "IndexType":{ "type":"string", "enum":[ "LOCAL", "AGGREGATOR" ] }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The request failed because of internal service error. Try your request again later.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ListIndexesForMembersInput":{ "type":"structure", "required":["AccountIdList"], "members":{ "AccountIdList":{ "shape":"ListIndexesForMembersInputAccountIdListList", "documentation":"The account IDs will limit the output to only indexes from these accounts.
" }, "MaxResults":{ "shape":"ListIndexesForMembersInputMaxResultsInteger", "documentation":"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.
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. The pagination tokens expire after 24 hours.
A structure that contains the details and status of each index.
" }, "NextToken":{ "shape":"String", "documentation":"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. The pagination tokens expire after 24 hours.
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.
" }, "Regions":{ "shape":"ListIndexesInputRegionsList", "documentation":"If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
" }, "MaxResults":{ "shape":"ListIndexesInputMaxResultsInteger", "documentation":"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.
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. The pagination tokens expire after 24 hours.
A structure that contains the details and status of each index.
" }, "NextToken":{ "shape":"String", "documentation":"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. The pagination tokens expire after 24 hours.
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.
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. The pagination tokens expire after 24 hours.
Specifies a service principal name. If specified, then the operation only returns the managed views that are managed by the input service.
" } } }, "ListManagedViewsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":50, "min":1 }, "ListManagedViewsInputNextTokenString":{ "type":"string", "max":2048, "min":1 }, "ListManagedViewsInputServicePrincipalString":{ "type":"string", "max":1024, "min":1 }, "ListManagedViewsOutput":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"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. The pagination tokens expire after 24 hours.
The list of managed views available in the Amazon Web Services Region in which you called this operation.
" } } }, "ListResourcesInput":{ "type":"structure", "members":{ "Filters":{ "shape":"SearchFilter", "documentation":"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.
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.
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.
" }, "NextToken":{ "shape":"ListResourcesInputNextTokenString", "documentation":"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. The pagination tokens expire after 24 hours.
The ListResources operation does not generate a NextToken if you set MaxResults to 1000.
The list of structures that describe the resources that match the query.
" }, "NextToken":{ "shape":"ListResourcesOutputNextTokenString", "documentation":"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. The pagination tokens expire after 24 hours.
The Amazon resource name (ARN) of the view that this operation used to perform the search.
" } } }, "ListResourcesOutputNextTokenString":{ "type":"string", "max":2048, "min":1 }, "ListResourcesOutputViewArnString":{ "type":"string", "max":1011, "min":1 }, "ListServiceIndexesInput":{ "type":"structure", "members":{ "Regions":{ "shape":"ListServiceIndexesInputRegionsList", "documentation":"A list of Amazon Web Services Regions to include in the search for indexes. If not specified, indexes from all Regions are returned.
" }, "MaxResults":{ "shape":"ListServiceIndexesInputMaxResultsInteger", "documentation":"The maximum number of index results to return in a single response. Valid values are between 1 and 100.
The pagination token from a previous ListServiceIndexes response. Use this token to retrieve the next set of results.
A list of Index objects that describe the Resource Explorer indexes found in the specified Regions.
The pagination token to use in a subsequent ListServiceIndexes request to retrieve the next set of results.
The maximum number of service view results to return in a single response. Valid values are between 1 and 50.
The pagination token from a previous ListServiceViews response. Use this token to retrieve the next set of results.
The pagination token to use in a subsequent ListServiceViews request to retrieve the next set of results.
A list of Amazon Resource Names (ARNs) for the service views available in the current Amazon Web Services account.
" } } }, "ListStreamingAccessForServicesInput":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListStreamingAccessForServicesInputMaxResultsInteger", "documentation":"The maximum number of streaming access entries to return in the response. If there are more results available, the response includes a NextToken value that you can use in a subsequent call to get the next set of results. The value must be between 1 and 50. If you don't specify a value, the default is 50.
" }, "NextToken":{ "shape":"String", "documentation":"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. The pagination tokens expire after 24 hours.
A list of Amazon Web Services services that have streaming access to your Resource Explorer data, including details about when the access was granted.
" }, "NextToken":{ "shape":"String", "documentation":"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. The pagination tokens expire after 24 hours.
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. The pagination tokens expire after 24 hours.
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.
The list of resource types supported by Resource Explorer.
" }, "NextToken":{ "shape":"String", "documentation":"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. The pagination tokens expire after 24 hours.
The Amazon resource name (ARN) of the view or index that you want to attach tags to.
", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceOutput":{ "type":"structure", "members":{ "Tags":{ "shape":"TagMap", "documentation":"The tag key and value pairs that you want to attach to the specified view or index.
" } } }, "ListViewsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"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. The pagination tokens expire after 24 hours.
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.
The list of views available in the Amazon Web Services Region in which you called this operation.
" }, "NextToken":{ "shape":"String", "documentation":"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. The pagination tokens expire after 24 hours.
The Amazon resource name (ARN) of the managed view.
" }, "ManagedViewName":{ "shape":"String", "documentation":"The name of the managed view.
" }, "TrustedService":{ "shape":"String", "documentation":"The service principal of the Amazon Web Services service that created and manages the managed view.
" }, "LastUpdatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when this managed view was last modified.
" }, "Owner":{ "shape":"String", "documentation":"The Amazon Web Services account that owns this managed view.
" }, "Scope":{ "shape":"String", "documentation":"An Amazon resource name (ARN) of an Amazon Web Services account or organization that specifies whether this managed view includes resources from only the specified Amazon Web Services account or all accounts in the specified organization.
" }, "IncludedProperties":{ "shape":"IncludedPropertyList", "documentation":"A structure that contains additional information about the managed view.
" }, "Filters":{"shape":"SearchFilter"}, "ResourcePolicy":{ "shape":"String", "documentation":"The resource policy that defines access to the managed view. To learn more about this policy, review Managed views.
" }, "Version":{ "shape":"String", "documentation":"The version of the managed view.
" } }, "documentation":"An Amazon Web Services-managed view is how other Amazon Web Services services can access resource information indexed by Resource Explorer for your Amazon Web Services account or organization with your consent. For more information, see Managed views.
" }, "ManagedViewArnList":{ "type":"list", "member":{"shape":"String"} }, "MemberIndex":{ "type":"structure", "members":{ "AccountId":{ "shape":"String", "documentation":"The account ID for the index.
" }, "Region":{ "shape":"String", "documentation":"The Amazon Web Services Region in which the index exists.
" }, "Arn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the index.
" }, "Type":{ "shape":"IndexType", "documentation":"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.
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.
" }, "MemberIndexList":{ "type":"list", "member":{"shape":"MemberIndex"} }, "OperationStatus":{ "type":"string", "enum":[ "SUCCEEDED", "FAILED", "IN_PROGRESS", "SKIPPED" ] }, "OrgConfiguration":{ "type":"structure", "required":["AWSServiceAccessStatus"], "members":{ "AWSServiceAccessStatus":{ "shape":"AWSServiceAccessStatus", "documentation":"This value displays whether your Amazon Web Services service access is ENABLED or DISABLED.
This value shows whether or not you have a valid a service-linked role required to start the multi-account search feature.
" } }, "documentation":"This is a structure that contains the status of Amazon Web Services service access, and whether you have a valid service-linked role to enable multi-account search for your organization.
" }, "QueryString":{ "type":"string", "max":1280, "min":0, "sensitive":true }, "RegionList":{ "type":"list", "member":{"shape":"RegionListMemberString"} }, "RegionListMemberString":{ "type":"string", "pattern":"[a-z-]+-[a-z]+-[0-9]" }, "RegionStatus":{ "type":"structure", "members":{ "Region":{ "shape":"RegionStatusRegionString", "documentation":"The Amazon Web Services Region for which this status information applies.
" }, "Index":{ "shape":"IndexStatus", "documentation":"The status information for the Resource Explorer index in this Region.
" }, "View":{ "shape":"ViewStatus", "documentation":"The status information for the Resource Explorer view in this Region.
" } }, "documentation":"Contains information about the status of Resource Explorer configuration in a specific Amazon Web Services Region.
" }, "RegionStatusList":{ "type":"list", "member":{"shape":"RegionStatus"} }, "RegionStatusRegionString":{ "type":"string", "pattern":"[a-z-]+-[a-z]+-[0-9]" }, "Resource":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the resource.
" }, "OwningAccountId":{ "shape":"String", "documentation":"The Amazon Web Services account that owns the resource.
" }, "Region":{ "shape":"String", "documentation":"The Amazon Web Services Region in which the resource was created and exists.
" }, "ResourceType":{ "shape":"String", "documentation":"The type of the resource.
" }, "Service":{ "shape":"String", "documentation":"The Amazon Web Services service that owns the resource and is responsible for creating and updating it.
" }, "LastReportedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.
" }, "Properties":{ "shape":"ResourcePropertyList", "documentation":"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.
" } }, "documentation":"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.
" }, "ResourceCount":{ "type":"structure", "members":{ "TotalResources":{ "shape":"Long", "documentation":"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.
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.
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.
" }, "ResourceList":{ "type":"list", "member":{"shape":"Resource"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceProperty":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"The name of this property of the resource.
" }, "LastReportedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time that the information about this resource property was last updated.
" }, "Data":{ "shape":"Document", "documentation":"Details about this property. The content of this field is a JSON object that varies based on the resource type.
" } }, "documentation":"A structure that describes a property of a resource.
" }, "ResourcePropertyList":{ "type":"list", "member":{"shape":"ResourceProperty"} }, "ResourceTypeList":{ "type":"list", "member":{"shape":"SupportedResourceType"} }, "SearchFilter":{ "type":"structure", "required":["FilterString"], "members":{ "FilterString":{ "shape":"SearchFilterFilterStringString", "documentation":"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.
" } }, "documentation":"A search filter defines which resources can be part of a search query result set.
", "sensitive":true }, "SearchFilterFilterStringString":{ "type":"string", "max":2048, "min":0 }, "SearchInput":{ "type":"structure", "required":["QueryString"], "members":{ "QueryString":{ "shape":"QueryString", "documentation":"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.
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.
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.
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. The pagination tokens expire after 24 hours.
The list of structures that describe the resources that match the query.
" }, "NextToken":{ "shape":"SearchOutputNextTokenString", "documentation":"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. The pagination tokens expire after 24 hours.
The Amazon resource name (ARN) of the view that this operation used to perform the search.
" }, "Count":{ "shape":"ResourceCount", "documentation":"The number of resources that match the query.
" } } }, "SearchOutputNextTokenString":{ "type":"string", "max":2048, "min":1 }, "SearchOutputViewArnString":{ "type":"string", "max":1011, "min":1 }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "Message", "Name", "Value" ], "members":{ "Message":{"shape":"String"}, "Name":{ "shape":"String", "documentation":"The name of the service quota that was exceeded by the request.
" }, "Value":{ "shape":"String", "documentation":"The current value for the quota that the request tried to exceed.
" } }, "documentation":"The request failed because it exceeds a service quota.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "ServiceView":{ "type":"structure", "required":["ServiceViewArn"], "members":{ "ServiceViewArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the service view.
" }, "ServiceViewName":{ "shape":"ServiceViewName", "documentation":"The name of the service view.
" }, "Filters":{"shape":"SearchFilter"}, "IncludedProperties":{ "shape":"IncludedPropertyList", "documentation":"A list of additional resource properties that are included in this view for search and filtering purposes.
" }, "StreamingAccessForService":{ "shape":"String", "documentation":"The Amazon Web Services service that has streaming access to this view's data.
" }, "ScopeType":{ "shape":"String", "documentation":"The scope type of the service view, which determines what resources are included.
" } }, "documentation":"Contains the configuration and properties of a Resource Explorer service view.
" }, "ServiceViewArnList":{ "type":"list", "member":{"shape":"String"} }, "ServiceViewName":{ "type":"string", "pattern":"[a-zA-Z0-9\\-]{1,64}" }, "StreamingAccessDetails":{ "type":"structure", "required":[ "ServicePrincipal", "CreatedAt" ], "members":{ "ServicePrincipal":{ "shape":"String", "documentation":"The service principal of the Amazon Web Services service that has streaming access to your Resource Explorer data. A service principal is a unique identifier for an Amazon Web Services service.
" }, "CreatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when streaming access was granted to the Amazon Web Services service, in ISO 8601 format.
" } }, "documentation":"Contains information about an Amazon Web Services service that has been granted streaming access to your Resource Explorer data.
" }, "StreamingAccessDetailsList":{ "type":"list", "member":{"shape":"StreamingAccessDetails"} }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"}, "sensitive":true }, "SupportedResourceType":{ "type":"structure", "members":{ "Service":{ "shape":"String", "documentation":"The Amazon Web Services service that is associated with the resource type. This is the primary service that lets you create and interact with resources of this type.
" }, "ResourceType":{ "shape":"String", "documentation":"The unique identifier of the resource type.
" } }, "documentation":"A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
" }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "TagMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"}, "sensitive":true }, "TagResourceInput":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the view or index that you want to attach tags to.
", "location":"uri", "locationName":"resourceArn" }, "Tags":{ "shape":"TagMap", "documentation":"A list of tag key and value pairs that you want to attach to the specified view or index.
" } } }, "TagResourceOutput":{ "type":"structure", "members":{} }, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "UnauthorizedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The principal making the request isn't permitted to perform the operation.
", "error":{ "httpStatusCode":401, "senderFault":true }, "exception":true }, "UntagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the view or index that you want to remove tags from.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"StringList", "documentation":"A list of the keys for the tags that you want to remove from the specified view or index.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceOutput":{ "type":"structure", "members":{} }, "UpdateIndexTypeInput":{ "type":"structure", "required":[ "Arn", "Type" ], "members":{ "Arn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the index that you want to update.
" }, "Type":{ "shape":"IndexType", "documentation":"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.
The Amazon resource name (ARN) of the index that you updated.
" }, "Type":{ "shape":"IndexType", "documentation":"Specifies the type of the specified index after the operation completes.
" }, "State":{ "shape":"IndexState", "documentation":"Indicates the state of the request to update the index. This operation is asynchronous. Call the GetIndex operation to check for changes.
" }, "LastUpdatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and timestamp when the index was last updated.
" } } }, "UpdateViewInput":{ "type":"structure", "required":["ViewArn"], "members":{ "ViewArn":{ "shape":"UpdateViewInputViewArnString", "documentation":"The Amazon resource name (ARN) of the view that you want to modify.
" }, "IncludedProperties":{ "shape":"IncludedPropertyList", "documentation":"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.
" }, "Filters":{ "shape":"SearchFilter", "documentation":"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.
Details about the view that you changed with this operation.
" } } }, "ValidationException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"}, "FieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"An array of the request fields that had validation errors.
" } }, "documentation":"You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "Name", "ValidationIssue" ], "members":{ "Name":{ "shape":"String", "documentation":"The name of the request field that had a validation error.
" }, "ValidationIssue":{ "shape":"String", "documentation":"The validation error caused by the request field.
" } }, "documentation":"A structure that describes a request field with a validation error.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "View":{ "type":"structure", "members":{ "ViewArn":{ "shape":"String", "documentation":"The Amazon resource name (ARN) of the view.
" }, "ViewName":{ "shape":"ViewName", "documentation":"The name of the view.
" }, "Owner":{ "shape":"String", "documentation":"The Amazon Web Services account that owns this view.
" }, "LastUpdatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time when this view was last modified.
" }, "Scope":{ "shape":"String", "documentation":"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.
" }, "IncludedProperties":{ "shape":"IncludedPropertyList", "documentation":"A structure that contains additional information about the view.
" }, "Filters":{ "shape":"SearchFilter", "documentation":"An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.
" } }, "documentation":"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\".
" }, "ViewArnList":{ "type":"list", "member":{"shape":"String"} }, "ViewList":{ "type":"list", "member":{"shape":"View"} }, "ViewName":{ "type":"string", "pattern":"[a-zA-Z0-9\\-]{1,64}" }, "ViewStatus":{ "type":"structure", "members":{ "Status":{ "shape":"OperationStatus", "documentation":"The current status of the view operation. Valid values are SUCCEEDED, FAILED, IN_PROGRESS, or SKIPPED.
Details about any error that occurred during the view operation.
" } }, "documentation":"Contains information about the status of a Resource Explorer view operation in a specific Region.
" } }, "documentation":"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.
" }