describe_logging_configuration

PrometheusService.Client.describe_logging_configuration(**kwargs)

Describes logging configuration.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The ID of the workspace to vend logs to.

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) --

      Metadata object containing information about the logging configuration of a workspace.

      • createdAt (datetime) --

        The time when the logging configuration was created.

      • logGroupArn (string) --

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

      • modifiedAt (datetime) --

        The time when the logging configuration was modified.

      • status (dict) --

        The status of the logging configuration.

        • statusCode (string) --

          Status code of the logging configuration.

        • statusReason (string) --

          The reason for failure if any.

      • workspace (string) --

        The workspace where the logging configuration exists.

Exceptions

  • PrometheusService.Client.exceptions.ValidationException
  • PrometheusService.Client.exceptions.ResourceNotFoundException
  • PrometheusService.Client.exceptions.AccessDeniedException
  • PrometheusService.Client.exceptions.InternalServerException