EC2 / Client / modify_verified_access_instance_logging_configuration

modify_verified_access_instance_logging_configuration

EC2.Client.modify_verified_access_instance_logging_configuration(**kwargs)

Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.

See also: AWS API Documentation

Request Syntax

response = client.modify_verified_access_instance_logging_configuration(
    VerifiedAccessInstanceId='string',
    AccessLogs={
        'S3': {
            'Enabled': True|False,
            'BucketName': 'string',
            'Prefix': 'string',
            'BucketOwner': 'string'
        },
        'CloudWatchLogs': {
            'Enabled': True|False,
            'LogGroup': 'string'
        },
        'KinesisDataFirehose': {
            'Enabled': True|False,
            'DeliveryStream': 'string'
        },
        'LogVersion': 'string',
        'IncludeTrustContext': True|False
    },
    DryRun=True|False,
    ClientToken='string'
)

Parameters:

• VerifiedAccessInstanceId (string) –

  [REQUIRED]

  The ID of the Verified Access instance.

• AccessLogs (dict) –

  [REQUIRED]

  The configuration options for Verified Access instances.

  • S3 (dict) –

    Sends Verified Access logs to Amazon S3.

    • Enabled (boolean) – [REQUIRED]

      Indicates whether logging is enabled.

    • BucketName (string) –

      The bucket name.

    • Prefix (string) –

      The bucket prefix.

    • BucketOwner (string) –

      The ID of the Amazon Web Services account that owns the Amazon S3 bucket.

  • CloudWatchLogs (dict) –

    Sends Verified Access logs to CloudWatch Logs.

    • Enabled (boolean) – [REQUIRED]

      Indicates whether logging is enabled.

    • LogGroup (string) –

      The ID of the CloudWatch Logs log group.

  • KinesisDataFirehose (dict) –

    Sends Verified Access logs to Kinesis.

    • Enabled (boolean) – [REQUIRED]

      Indicates whether logging is enabled.

    • DeliveryStream (string) –

      The ID of the delivery stream.

  • LogVersion (string) –

    The logging version to use.

    Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2

  • IncludeTrustContext (boolean) –

    Include trust data sent by trust providers into the logs.

• 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.

• ClientToken (string) –

  A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'LoggingConfiguration': {
        '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
        }
    }
}

Response Structure

• (dict) –

  • LoggingConfiguration (dict) –

    The logging configuration for the 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) –

        Describes current setting for the logging version.

      • IncludeTrustContext (boolean) –

        Describes current setting for including trust data into the logs.