EC2 / Client / describe_verified_access_instance_logging_configurations

describe_verified_access_instance_logging_configurations

EC2.Client.describe_verified_access_instance_logging_configurations(**kwargs)

Describes the specified Amazon Web Services Verified Access instances.

See also: AWS API Documentation

Request Syntax

response = client.describe_verified_access_instance_logging_configurations(
    VerifiedAccessInstanceIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

• VerifiedAccessInstanceIds (list) –

  The IDs of the Verified Access instances.

  • (string) –

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• NextToken (string) – The token for the next page of results.

• Filters (list) –

  One or more filters. Filter names and values are case-sensitive.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'LoggingConfigurations': [
        {
            'VerifiedAccessInstanceId': 'string',
            'AccessLogs': {
                'S3': {
                    'Enabled': True|False,
                    'DeliveryStatus': {
                        'Code': 'success'|'failed',
                        'Message': 'string'
                    },
                    'BucketName': 'string',
                    'Prefix': 'string',
                    'BucketOwner': 'string'
                },
                'CloudWatchLogs': {
                    'Enabled': True|False,
                    'DeliveryStatus': {
                        'Code': 'success'|'failed',
                        'Message': 'string'
                    },
                    'LogGroup': 'string'
                },
                'KinesisDataFirehose': {
                    'Enabled': True|False,
                    'DeliveryStatus': {
                        'Code': 'success'|'failed',
                        'Message': 'string'
                    },
                    'DeliveryStream': 'string'
                },
                'LogVersion': 'string',
                'IncludeTrustContext': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • LoggingConfigurations (list) –

    The logging configuration for the Verified Access instances.

    • (dict) –

      Describes logging options for an Amazon Web Services Verified Access instance.

      • VerifiedAccessInstanceId (string) –

        The ID of the Amazon Web Services Verified Access instance.

      • AccessLogs (dict) –

        Details about the logging options.

        • S3 (dict) –

          Amazon S3 logging options.

          • Enabled (boolean) –

            Indicates whether logging is enabled.

          • DeliveryStatus (dict) –

            The delivery status.

            • Code (string) –

              The status code.

            • Message (string) –

              The status message.

          • BucketName (string) –

            The bucket name.

          • Prefix (string) –

            The bucket prefix.

          • BucketOwner (string) –

            The Amazon Web Services account number that owns the bucket.

        • CloudWatchLogs (dict) –

          CloudWatch Logs logging destination.

          • Enabled (boolean) –

            Indicates whether logging is enabled.

          • DeliveryStatus (dict) –

            The delivery status for access logs.

            • Code (string) –

              The status code.

            • Message (string) –

              The status message.

          • LogGroup (string) –

            The ID of the CloudWatch Logs log group.

        • KinesisDataFirehose (dict) –

          Kinesis logging destination.

          • Enabled (boolean) –

            Indicates whether logging is enabled.

          • DeliveryStatus (dict) –

            The delivery status.

            • Code (string) –

              The status code.

            • Message (string) –

              The status message.

          • DeliveryStream (string) –

            The ID of the delivery stream.

        • LogVersion (string) –

          The log version.

        • IncludeTrustContext (boolean) –

          Indicates whether trust data is included in the logs.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.