ResourceExplorer / Client / get_service_view

get_service_view

ResourceExplorer.Client.get_service_view(**kwargs)

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

response = client.get_service_view(
    ServiceViewArn='string'
)
Parameters:

ServiceViewArn (string) –

[REQUIRED]

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

Return type:

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.

Exceptions