Artifact / Client / get_report_metadata

get_report_metadata

Artifact.Client.get_report_metadata(**kwargs)

Get the metadata for a single report.

See also: AWS API Documentation

Request Syntax

response = client.get_report_metadata(
    reportId='string',
    reportVersion=123
)

Parameters:

• reportId (string) –

  [REQUIRED]

  Unique resource ID for the report resource.

• reportVersion (integer) – Version for the report resource.

Return type:

dict

Returns:

Response Syntax

{
    'reportDetails': {
        'acceptanceType': 'PASSTHROUGH'|'EXPLICIT',
        'arn': 'string',
        'category': 'string',
        'companyName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deletedAt': datetime(2015, 1, 1),
        'description': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'periodEnd': datetime(2015, 1, 1),
        'periodStart': datetime(2015, 1, 1),
        'productName': 'string',
        'sequenceNumber': 123,
        'series': 'string',
        'state': 'PUBLISHED'|'UNPUBLISHED',
        'statusMessage': 'string',
        'termArn': 'string',
        'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT',
        'version': 123
    }
}

Response Structure

• (dict) –

  • reportDetails (dict) –

    Report resource detail.

    • acceptanceType (string) –

      Acceptance type for report.

    • arn (string) –

      ARN for the report resource.

    • category (string) –

      Category for the report resource.

    • companyName (string) –

      Associated company name for the report resource.

    • createdAt (datetime) –

      Timestamp indicating when the report resource was created.

    • deletedAt (datetime) –

      Timestamp indicating when the report resource was deleted.

    • description (string) –

      Description for the report resource.

    • id (string) –

      Unique resource ID for the report resource.

    • lastModifiedAt (datetime) –

      Timestamp indicating when the report resource was last modified.

    • name (string) –

      Name for the report resource.

    • periodEnd (datetime) –

      Timestamp indicating the report resource effective end.

    • periodStart (datetime) –

      Timestamp indicating the report resource effective start.

    • productName (string) –

      Associated product name for the report resource.

    • sequenceNumber (integer) –

      Sequence number to enforce optimistic locking.

    • series (string) –

      Series for the report resource.

    • state (string) –

      Current state of the report resource

    • statusMessage (string) –

      The message associated with the current upload state.

    • termArn (string) –

      Unique resource ARN for term resource.

    • uploadState (string) –

      The current state of the document upload.

    • version (integer) –

      Version for the report resource.

Exceptions

• Artifact.Client.exceptions.ResourceNotFoundException

• Artifact.Client.exceptions.ThrottlingException

• Artifact.Client.exceptions.AccessDeniedException

• Artifact.Client.exceptions.InternalServerException

• Artifact.Client.exceptions.ValidationException

• Artifact.Client.exceptions.ServiceQuotaExceededException