PrometheusService / Client / describe_logging_configuration

describe_logging_configuration#

PrometheusService.Client.describe_logging_configuration(**kwargs)#

Returns complete information about the current logging configuration of the workspace.

See also: AWS API Documentation

Request Syntax

response = client.describe_logging_configuration(
    workspaceId='string'
)
Parameters:

workspaceId (string) –

[REQUIRED]

The ID of the workspace to describe the logging configuration for.

Return type:

dict

Returns:

Response Syntax

{
    'loggingConfiguration': {
        'createdAt': datetime(2015, 1, 1),
        'logGroupArn': 'string',
        'modifiedAt': datetime(2015, 1, 1),
        'status': {
            'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
            'statusReason': 'string'
        },
        'workspace': 'string'
    }
}

Response Structure

  • (dict) –

    Represents the output of a DescribeLoggingConfiguration operation.

    • loggingConfiguration (dict) –

      A structure that displays the information about the logging configuration.

      • createdAt (datetime) –

        The date and time that the logging configuration was created.

      • logGroupArn (string) –

        The ARN of the CloudWatch log group to which the vended log data will be published.

      • modifiedAt (datetime) –

        The date and time that the logging configuration was most recently changed.

      • status (dict) –

        The current status of the logging configuration.

        • statusCode (string) –

          The current status of the logging configuration.

        • statusReason (string) –

          If failed, the reason for the failure.

      • workspace (string) –

        The ID of the workspace the logging configuration is for.

Exceptions

  • PrometheusService.Client.exceptions.ValidationException

  • PrometheusService.Client.exceptions.ResourceNotFoundException

  • PrometheusService.Client.exceptions.AccessDeniedException

  • PrometheusService.Client.exceptions.InternalServerException