AssociateDefaultView

$result = $client->associateDefaultView([/* ... */]);
$promise = $client->associateDefaultViewAsync([/* ... */]);

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

BatchGetView

$result = $client->batchGetView([/* ... */]);
$promise = $client->batchGetViewAsync([/* ... */]);

Retrieves details about a list of views.

Parameter Syntax

$result = $client->batchGetView([
    'ViewArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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.

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.

CreateIndex

$result = $client->createIndex([/* ... */]);
$promise = $client->createIndexAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->createIndex([
    'ClientToken' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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.

ConflictException:

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.

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.

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

Result Syntax

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

Result Details

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.

ConflictException:

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.

ServiceQuotaExceededException:

The request failed because it exceeds a service quota.

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.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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 can invoke this API call.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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.

GetManagedView

$result = $client->getManagedView([/* ... */]);
$promise = $client->getManagedViewAsync([/* ... */]);

Retrieves details of the specified Amazon Web Services-managed view.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ManagedView' => [
        'Filters' => [
            'FilterString' => '<string>',
        ],
        'IncludedProperties' => [
            [
                'Name' => '<string>',
            ],
            // ...
        ],
        'LastUpdatedAt' => <DateTime>,
        'ManagedViewArn' => '<string>',
        'ManagedViewName' => '<string>',
        'Owner' => '<string>',
        'ResourcePolicy' => '<string>',
        'Scope' => '<string>',
        'TrustedService' => '<string>',
        'Version' => '<string>',
    ],
]

Result Details

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.

GetView

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

Retrieves details of the specified view.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

ListManagedViews

$result = $client->listManagedViews([/* ... */]);
$promise = $client->listManagedViewsAsync([/* ... */]);

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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.

ListResources

$result = $client->listResources([/* ... */]);
$promise = $client->listResourcesAsync([/* ... */]);

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    '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

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

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

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

Result Syntax

[]

Result Details

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.

ConflictException:

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.

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.

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

ConflictException:

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.

ServiceQuotaExceededException:

The request failed because it exceeds a service quota.

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.

UpdateView

$result = $client->updateView([/* ... */]);
$promise = $client->updateViewAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateView([
    'Filters' => [
        'FilterString' => '<string>', // REQUIRED
    ],
    'IncludedProperties' => [
        [
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ViewArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.

ServiceQuotaExceededException:

The request failed because it exceeds a service quota.

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.