ResourceExplorer / Client / batch_get_view

batch_get_view#

ResourceExplorer.Client.batch_get_view(**kwargs)#

Retrieves details about a list of views.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_view(
    ViewArns=[
        'string',
    ]
)
Parameters:

ViewArns (list) –

A list of Amazon resource names (ARNs) that identify the views you want details for.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Errors': [
        {
            'ErrorMessage': 'string',
            'ViewArn': 'string'
        },
    ],
    'Views': [
        {
            'Filters': {
                'FilterString': 'string'
            },
            'IncludedProperties': [
                {
                    'Name': 'string'
                },
            ],
            'LastUpdatedAt': datetime(2015, 1, 1),
            'Owner': 'string',
            'Scope': 'string',
            'ViewArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Errors (list) –

      If any of the specified ARNs result in an error, then this structure describes the error.

      • (dict) –

        A collection of error messages for any views that Amazon Web Services Resource Explorer couldn’t retrieve details.

        • ErrorMessage (string) –

          The description of the error for the specified view.

        • ViewArn (string) –

          The Amazon resource name (ARN) of the view for which Resource Explorer failed to retrieve details.

    • Views (list) –

      A structure with a list of objects with details for each of the specified views.

      • (dict) –

        A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key “ENV” and the value “DEVELOPMENT” in the results returned by this view. You could also create a second view that includes only resources that are tagged with “ENV” and “PRODUCTION”.

        • Filters (dict) –

          An array of SearchFilter objects that specify which resources can be included in the results of queries made using this view.

          • 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 structure that contains additional information about the view.

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

        • LastUpdatedAt (datetime) –

          The date and time when this view was last modified.

        • Owner (string) –

          The Amazon Web Services account that owns this view.

        • Scope (string) –

          An Amazon resource name (ARN) of an Amazon Web Services account, an organization, or an organizational unit (OU) that specifies whether this view includes resources from only the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in the specified OU.

          If not specified, the value defaults to the Amazon Web Services account used to call this operation.

        • ViewArn (string) –

          The Amazon resource name (ARN) of the view.

Exceptions