get_view#

ResourceExplorer.Client.get_view(**kwargs)#

Retrieves details of the specified view.

Request Syntax

response = client.get_view(
    ViewArn='string'
)

Parameters:

ViewArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- Tags (dict) –
  
  Tag key and value pairs that are attached to the view.
  - (string) –
    - (string) –
- View (dict) –
  
  A structure that contains the details for the requested view.
  - 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

ResourceExplorer.Client.exceptions.ResourceNotFoundException
ResourceExplorer.Client.exceptions.InternalServerException
ResourceExplorer.Client.exceptions.ValidationException
ResourceExplorer.Client.exceptions.UnauthorizedException
ResourceExplorer.Client.exceptions.ThrottlingException
ResourceExplorer.Client.exceptions.AccessDeniedException