SDK for PHP 3.x

The request failed because of internal service error. Try your request again later.

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

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.

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

The credentials that you used to call this operation don't have the minimum required permissions.

CreateView

$result = $client->createView([/* ... */]);
$promise = $client->createViewAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createView([
    'ClientToken' => '<string>',
    'Filters' => [
        'FilterString' => '<string>', // REQUIRED
    ],
    'IncludedProperties' => [
        [
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Scope' => '<string>',
    'Tags' => ['<string>', ...],
    'ViewName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

: Type: string

Filters

: Type: SearchFilter structure

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.

IncludedProperties

: Type: Array of IncludedProperty structures

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

: Type: string

The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.

Tags

: Type: Associative array of custom strings keys (String) to strings

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

ViewName

: Required: Yes
: Type: string

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.

Result Syntax

[
    'View' => [
        'Filters' => [
            'FilterString' => '<string>',
        ],
        'IncludedProperties' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedAt' => <DateTime>,
        'Owner' => '<string>',
        'Scope' => '<string>',
        'ViewArn' => '<string>',
    ],
]

Result Details

Members

View

: Type: View structure

A structure that contains the details about the new view.

Errors

The request failed because of internal service error. Try your request again later.

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ServiceQuotaExceededException:

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.

The request failed because it exceeds a service quota.

UnauthorizedException:

The principal making the request isn't permitted to perform the operation.

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

The credentials that you used to call this operation don't have the minimum required permissions.

DeleteIndex

$result = $client->deleteIndex([/* ... */]);
$promise = $client->deleteIndexAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteIndex([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

: Required: Yes
: Type: string

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

Result Syntax

[
    'Arn' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'State' => 'CREATING|ACTIVE|DELETING|DELETED|UPDATING',
]

Result Details

Members

Arn

: Type: string

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.

LastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when you last updated this index.

State

: Type: string

Indicates the current state of the index.

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

DeleteView

$result = $client->deleteView([/* ... */]);
$promise = $client->deleteViewAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteView([
    'ViewArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ViewArn

: Required: Yes
: Type: string

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

Result Syntax

[
    'ViewArn' => '<string>',
]

Result Details

Members

ViewArn

: Type: string

The Amazon resource name (ARN) of the view that you successfully deleted.

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
UnauthorizedException:: The principal making the request isn't permitted to perform the operation.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

DisassociateDefaultView

$result = $client->disassociateDefaultView([/* ... */]);
$promise = $client->disassociateDefaultViewAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disassociateDefaultView([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

GetAccountLevelServiceConfiguration

$result = $client->getAccountLevelServiceConfiguration([/* ... */]);
$promise = $client->getAccountLevelServiceConfigurationAsync([/* ... */]);

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 or a delegated administrator with service access enabled can invoke this API call.

Parameter Syntax

$result = $client->getAccountLevelServiceConfiguration([
]);

Parameter Details

Members

Result Syntax

[
    'OrgConfiguration' => [
        'AWSServiceAccessStatus' => 'ENABLED|DISABLED',
        'ServiceLinkedRole' => '<string>',
    ],
]

Result Details

Members

OrgConfiguration

: Type: OrgConfiguration structure

Details about the organization, and whether configuration is ENABLED or DISABLED.

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

GetDefaultView

$result = $client->getDefaultView([/* ... */]);
$promise = $client->getDefaultViewAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getDefaultView([
]);

Parameter Details

Members

Result Syntax

[
    'ViewArn' => '<string>',
]

Result Details

Members

ViewArn

: Type: string

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.

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

GetIndex

$result = $client->getIndex([/* ... */]);
$promise = $client->getIndexAsync([/* ... */]);

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

Parameter Syntax

$result = $client->getIndex([
]);

Parameter Details

Members

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'LastUpdatedAt' => <DateTime>,
    'ReplicatingFrom' => ['<string>', ...],
    'ReplicatingTo' => ['<string>', ...],
    'State' => 'CREATING|ACTIVE|DELETING|DELETED|UPDATING',
    'Tags' => ['<string>', ...],
    'Type' => 'LOCAL|AGGREGATOR',
]

Result Details

Members

Arn

: Type: string

The Amazon resource name (ARN) of the index.

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the index was originally created.

LastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the index was last updated.

ReplicatingFrom

: Type: Array of strings

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

: Type: Array of strings

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.

State

: Type: string

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

Tags

: Type: Associative array of custom strings keys (String) to strings

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

Type

: Type: string

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.

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

GetView

$result = $client->getView([/* ... */]);
$promise = $client->getViewAsync([/* ... */]);

Retrieves details of the specified view.

Parameter Syntax

$result = $client->getView([
    'ViewArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ViewArn

: Required: Yes
: Type: string

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

Result Syntax

[
    'Tags' => ['<string>', ...],
    'View' => [
        'Filters' => [
            'FilterString' => '<string>',
        ],
        'IncludedProperties' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedAt' => <DateTime>,
        'Owner' => '<string>',
        'Scope' => '<string>',
        'ViewArn' => '<string>',
    ],
]

Result Details

Members

Tags

: Type: Associative array of custom strings keys (String) to strings

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

View

: Type: View structure

A structure that contains the details for the requested view.

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
UnauthorizedException:: The principal making the request isn't permitted to perform the operation.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

ListIndexes

$result = $client->listIndexes([/* ... */]);
$promise = $client->listIndexesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listIndexes([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Regions' => ['<string>', ...],
    'Type' => 'LOCAL|AGGREGATOR',
]);

Parameter Details

Members

MaxResults

: Type: int

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.

NextToken

: Type: string

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.

Regions

: Type: Array of strings

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

Type

: Type: string

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.

Result Syntax

[
    'Indexes' => [
        [
            'Arn' => '<string>',
            'Region' => '<string>',
            'Type' => 'LOCAL|AGGREGATOR',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Indexes

: Type: Array of Index structures

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

NextToken

: Type: string

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.

Errors

InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

ListIndexesForMembers

$result = $client->listIndexesForMembers([/* ... */]);
$promise = $client->listIndexesForMembersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listIndexesForMembers([
    'AccountIdList' => ['<string>', ...], // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AccountIdList

: Required: Yes
: Type: Array of strings

The account IDs will limit the output to only indexes from these accounts.

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'Indexes' => [
        [
            'AccountId' => '<string>',
            'Arn' => '<string>',
            'Region' => '<string>',
            'Type' => 'LOCAL|AGGREGATOR',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Indexes

: Type: Array of MemberIndex structures

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

NextToken

: Type: string

Errors

InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

ListSupportedResourceTypes

$result = $client->listSupportedResourceTypes([/* ... */]);
$promise = $client->listSupportedResourceTypesAsync([/* ... */]);

Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.

Parameter Syntax

$result = $client->listSupportedResourceTypes([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceTypes' => [
        [
            'ResourceType' => '<string>',
            'Service' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

ResourceTypes

: Type: Array of SupportedResourceType structures

The list of resource types supported by Resource Explorer.

Errors

InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags that are attached to the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

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

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

: Type: Associative array of custom strings keys (String) to strings

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

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
UnauthorizedException:: The principal making the request isn't permitted to perform the operation.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

ListViews

$result = $client->listViews([/* ... */]);
$promise = $client->listViewsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listViews([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Views' => ['<string>', ...],
]

Result Details

Members

NextToken

: Type: string

Views

: Type: Array of strings

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

Errors

InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

Search

$result = $client->search([/* ... */]);
$promise = $client->searchAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->search([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueryString' => '<string>', // REQUIRED
    'ViewArn' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

NextToken

: Type: string

QueryString

: Required: Yes
: Type: string

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.

ViewArn

: Type: string

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.

Result Syntax

[
    'Count' => [
        'Complete' => true || false,
        'TotalResources' => <integer>,
    ],
    'NextToken' => '<string>',
    'Resources' => [
        [
            'Arn' => '<string>',
            'LastReportedAt' => <DateTime>,
            'OwningAccountId' => '<string>',
            'Properties' => [
                [
                    'Data' => [
                    ],
                    'LastReportedAt' => <DateTime>,
                    'Name' => '<string>',
                ],
                // ...
            ],
            'Region' => '<string>',
            'ResourceType' => '<string>',
            'Service' => '<string>',
        ],
        // ...
    ],
    'ViewArn' => '<string>',
]

Result Details

Members

Count

: Type: ResourceCount structure

The number of resources that match the query.

NextToken

: Type: string

Resources

: Type: Array of Resource structures

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

ViewArn

: Type: string

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

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
UnauthorizedException:: The principal making the request isn't permitted to perform the operation.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.

Parameter Syntax

$result = $client->tagResource([
    'Tags' => ['<string>', ...],
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Tags

: Type: Associative array of custom strings keys (String) to strings

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

resourceArn

: Required: Yes
: Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The request failed because of internal service error. Try your request again later.

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

UnauthorizedException:

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.

The principal making the request isn't permitted to perform the operation.

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

ResourceNotFoundException:

The credentials that you used to call this operation don't have the minimum required permissions.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

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

tagKeys

: Required: Yes
: Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.
InternalServerException:: The request failed because of internal service error. Try your request again later.
ValidationException:: You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
UnauthorizedException:: The principal making the request isn't permitted to perform the operation.
ThrottlingException:: The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
AccessDeniedException:: The credentials that you used to call this operation don't have the minimum required permissions.

UpdateIndexType

$result = $client->updateIndexType([/* ... */]);
$promise = $client->updateIndexTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateIndexType([
    'Arn' => '<string>', // REQUIRED
    'Type' => 'LOCAL|AGGREGATOR', // REQUIRED
]);

Parameter Details

Members

Arn

: Required: Yes
: Type: string

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

Type

: Required: Yes
: Type: string

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.

Result Syntax

[
    'Arn' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'State' => 'CREATING|ACTIVE|DELETING|DELETED|UPDATING',
    'Type' => 'LOCAL|AGGREGATOR',
]

Result Details

Members

Arn

: Type: string

The Amazon resource name (ARN) of the index that you updated.

LastUpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and timestamp when the index was last updated.

State

: Type: string

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

Type

: Type: string

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

Errors

You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

The request failed because of internal service error. Try your request again later.

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

ServiceQuotaExceededException:

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.

The request failed because it exceeds a service quota.

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.