CleanRoomsService / Client / list_collaboration_analysis_templates

list_collaboration_analysis_templates#

CleanRoomsService.Client.list_collaboration_analysis_templates(**kwargs)#

Lists analysis templates within a collaboration.

See also: AWS API Documentation

Request Syntax

response = client.list_collaboration_analysis_templates(
    collaborationIdentifier='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • collaborationIdentifier (string) –

    [REQUIRED]

    A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

  • nextToken (string) – The token value retrieved from a previous call to access the next page of results.

  • maxResults (integer) – The maximum size of the results that is returned per call.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      The token value retrieved from a previous call to access the next page of results.

    • collaborationAnalysisTemplateSummaries (list) –

      The metadata of the analysis template within a collaboration.

      • (dict) –

        The metadata of the analysis template within a collaboration.

        • arn (string) –

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

        • createTime (datetime) –

          The time that the summary of the analysis template in a collaboration was created.

        • id (string) –

          The identifier of the analysis template.

        • name (string) –

          The name of the analysis template.

        • updateTime (datetime) –

          The time that the summary of the analysis template in the collaboration was last updated.

        • collaborationArn (string) –

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

        • collaborationId (string) –

          A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

        • creatorAccountId (string) –

          The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

        • description (string) –

          The description of the analysis template.

Exceptions

  • CleanRoomsService.Client.exceptions.ResourceNotFoundException

  • CleanRoomsService.Client.exceptions.InternalServerException

  • CleanRoomsService.Client.exceptions.ValidationException

  • CleanRoomsService.Client.exceptions.ThrottlingException

  • CleanRoomsService.Client.exceptions.AccessDeniedException