AWS Resource Explorer

2026/06/29 - AWS Resource Explorer - 4 updated api methods

Changes  Added CFN resource type fields for Search and ListSupportedResourceTypes responses. Added SLRec field for ServiceView

GetServiceView (updated) Link ¶
Changes (response)
{'View': {'ServiceLinkedRecorder': {'RecorderName': 'string',
                                    'RecorderType': 'AWS | THIRD_PARTY',
                                    'ServicePrincipal': 'string'}}}

Retrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.

See also: AWS API Documentation

Request Syntax

client.get_service_view(
    ServiceViewArn='string'
)
type ServiceViewArn:

string

param ServiceViewArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the service view to retrieve details for.

rtype:

dict

returns:

Response Syntax

{
    'View': {
        'ServiceViewArn': 'string',
        'ServiceViewName': 'string',
        'Filters': {
            'FilterString': 'string'
        },
        'IncludedProperties': [
            {
                'Name': 'string'
            },
        ],
        'StreamingAccessForService': 'string',
        'ScopeType': 'string',
        'ServiceLinkedRecorder': {
            'ServicePrincipal': 'string',
            'RecorderName': 'string',
            'RecorderType': 'AWS'|'THIRD_PARTY'
        }
    }
}

Response Structure

  • (dict) --

    • View (dict) --

      A ServiceView object that contains the details and configuration of the requested service view.

      • ServiceViewArn (string) --

        The Amazon Resource Name (ARN) of the service view.

      • ServiceViewName (string) --

        The name of the service view.

      • Filters (dict) --

        A search filter defines which resources can be part of a search query result set.

        • FilterString (string) --

          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.

      • IncludedProperties (list) --

        A list of additional resource properties that are included in this view for search and filtering purposes.

        • (dict) --

          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.

          • Name (string) --

            The name of the property that is included in this view.

            You can specify the following property names for this field:

            • tags

      • StreamingAccessForService (string) --

        The Amazon Web Services service that has streaming access to this view's data.

      • ScopeType (string) --

        The scope type of the service view, which determines what resources are included.

      • ServiceLinkedRecorder (dict) --

        Information about the service-linked recorder associated with this service view. When a service view is paired with a service-linked recorder, Resource Explorer uses the recorder's resource type list to filter search results and streaming data.

        • ServicePrincipal (string) --

          The service principal of the Amazon Web Services service that owns the service-linked recorder, such as observabilityadmin.amazonaws.com.

        • RecorderName (string) --

          The name of the service-linked recorder, such as AWSConfigurationRecorderForObservabilityAdmin.

        • RecorderType (string) --

          The type of the recorder. Valid values are AWS and THIRD_PARTY.

ListResources (updated) Link ¶
Changes (response)
{'Resources': {'CfnResourceType': 'string'}}

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.

See also: AWS API Documentation

Request Syntax

client.list_resources(
    Filters={
        'FilterString': 'string'
    },
    MaxResults=123,
    ViewArn='string',
    NextToken='string'
)
type Filters:

dict

param Filters:

An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.

For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.

  • FilterString (string) -- [REQUIRED]

    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.

type MaxResults:

integer

param MaxResults:

The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

type ViewArn:

string

param ViewArn:

Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.

type NextToken:

string

param NextToken:

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

rtype:

dict

returns:

Response Syntax

{
    'Resources': [
        {
            'Arn': 'string',
            'OwningAccountId': 'string',
            'Region': 'string',
            'ResourceType': 'string',
            'Service': 'string',
            'CfnResourceType': 'string',
            'LastReportedAt': datetime(2015, 1, 1),
            'Properties': [
                {
                    'Name': 'string',
                    'LastReportedAt': datetime(2015, 1, 1),
                    'Data': {...}|[...]|123|123.4|'string'|True|None
                },
            ]
        },
    ],
    'NextToken': 'string',
    'ViewArn': 'string'
}

Response Structure

  • (dict) --

    • Resources (list) --

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

      • (dict) --

        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.

        • Arn (string) --

          The Amazon resource name (ARN) of the resource.

        • OwningAccountId (string) --

          The Amazon Web Services account that owns the resource.

        • Region (string) --

          The Amazon Web Services Region in which the resource was created and exists.

        • ResourceType (string) --

          The type of the resource.

        • Service (string) --

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

        • CfnResourceType (string) --

          The CloudFormation resource type identifier for the resource, such as AWS::EC2::Instance or AWS::S3::Bucket.

        • LastReportedAt (datetime) --

          The date and time that Resource Explorer last queried this resource and updated the index with the latest information about the resource.

        • Properties (list) --

          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.

          • (dict) --

            A structure that describes a property of a resource.

            • Name (string) --

              The name of this property of the resource.

            • LastReportedAt (datetime) --

              The date and time that the information about this resource property was last updated.

            • Data (:ref:`document<document>`) --

              Details about this property. The content of this field is a JSON object that varies based on the resource type.

    • NextToken (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.

    • ViewArn (string) --

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

ListSupportedResourceTypes (updated) Link ¶
Changes (response)
{'ResourceTypes': {'CFNResourceTypes': ['string']}}

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

See also: AWS API Documentation

Request Syntax

client.list_supported_resource_types(
    NextToken='string',
    MaxResults=123
)
type NextToken:

string

param NextToken:

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

type MaxResults:

integer

param MaxResults:

The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

rtype:

dict

returns:

Response Syntax

{
    'ResourceTypes': [
        {
            'Service': 'string',
            'ResourceType': 'string',
            'CFNResourceTypes': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ResourceTypes (list) --

      The list of resource types supported by Resource Explorer.

      • (dict) --

        A structure that describes a resource type supported by Amazon Web Services Resource Explorer.

        • Service (string) --

          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 (string) --

          The unique identifier of the resource type.

        • CFNResourceTypes (list) --

          The CloudFormation resource type identifiers for this resource type, such as AWS::EC2::Instance.

          • (string) --

    • NextToken (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.