CleanRoomsService / Client / list_analysis_templates

list_analysis_templates#

CleanRoomsService.Client.list_analysis_templates(**kwargs)#

Lists analysis templates that the caller owns.

See also: AWS API Documentation

Request Syntax

response = client.list_analysis_templates(
    membershipIdentifier='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • membershipIdentifier (string) –

    [REQUIRED]

    The identifier for a membership resource.

  • nextToken (string) – The pagination token that’s used to fetch the next set of results.

  • maxResults (integer) – The maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a nextToken even if the maxResults value has not been met.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'analysisTemplateSummaries': [
        {
            'arn': 'string',
            'createTime': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'updateTime': datetime(2015, 1, 1),
            'membershipArn': 'string',
            'membershipId': 'string',
            'collaborationArn': 'string',
            'collaborationId': 'string',
            'description': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The pagination token that’s used to fetch the next set of results.

    • analysisTemplateSummaries (list) –

      Lists analysis template metadata.

      • (dict) –

        The metadata of the analysis template.

        • arn (string) –

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

        • createTime (datetime) –

          The time that the analysis template summary was created.

        • id (string) –

          The identifier of the analysis template.

        • name (string) –

          The name of the analysis template.

        • updateTime (datetime) –

          The time that the analysis template summary was last updated.

        • membershipArn (string) –

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

        • membershipId (string) –

          The identifier for a membership resource.

        • collaborationArn (string) –

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

        • collaborationId (string) –

          A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.

        • description (string) –

          The description of the analysis template.

Exceptions