CleanRoomsService / Client / get_analysis_template

get_analysis_template

CleanRoomsService.Client.get_analysis_template(**kwargs)

Retrieves an analysis template.

See also: AWS API Documentation

Request Syntax

response = client.get_analysis_template(
    membershipIdentifier='string',
    analysisTemplateIdentifier='string'
)

Parameters:

• membershipIdentifier (string) –

  [REQUIRED]

  The identifier for a membership resource.

• analysisTemplateIdentifier (string) –

  [REQUIRED]

  The identifier for the analysis template resource.

Return type:

dict

Returns:

Response Syntax

{
    'analysisTemplate': {
        'id': 'string',
        'arn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'description': 'string',
        'name': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'schema': {
            'referencedTables': [
                'string',
            ]
        },
        'format': 'SQL',
        'source': {
            'text': 'string'
        },
        'analysisParameters': [
            {
                'name': 'string',
                'type': 'SMALLINT'|'INTEGER'|'BIGINT'|'DECIMAL'|'REAL'|'DOUBLE_PRECISION'|'BOOLEAN'|'CHAR'|'VARCHAR'|'DATE'|'TIMESTAMP'|'TIMESTAMPTZ'|'TIME'|'TIMETZ'|'VARBYTE',
                'defaultValue': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • analysisTemplate (dict) –

    The analysis template.

    • id (string) –

      The identifier for the analysis template.

    • arn (string) –

      The Amazon Resource Name (ARN) of the analysis template.

    • collaborationId (string) –

      The unique ID for the associated collaboration of the analysis template.

    • collaborationArn (string) –

      The unique ARN for the analysis template’s associated collaboration.

    • membershipId (string) –

      The identifier of a member who created the analysis template.

    • membershipArn (string) –

      The Amazon Resource Name (ARN) of the member who created the analysis template.

    • description (string) –

      The description of the analysis template.

    • name (string) –

      The name of the analysis template.

    • createTime (datetime) –

      The time that the analysis template was created.

    • updateTime (datetime) –

      The time that the analysis template was last updated.

    • schema (dict) –

      The entire schema object.

      • referencedTables (list) –

        The tables referenced in the analysis schema.

        • (string) –

    • format (string) –

      The format of the analysis template.

    • source (dict) –

      The source of the analysis template.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: text. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • text (string) –

        The query text.

    • analysisParameters (list) –

      The parameters of the analysis template.

      • (dict) –

        Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.

        • name (string) –

          The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

        • type (string) –

          The type of parameter.

        • defaultValue (string) –

          Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

Exceptions

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException