CloudWatchLogs / Client / put_delivery_source

put_delivery_source#

CloudWatchLogs.Client.put_delivery_source(**kwargs)#

Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.

To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:

  • Use PutDeliverySource to create a delivery source, which is a logical object that represents the resource that is actually sending the logs.

  • Use PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

  • If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

  • Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.

See also: AWS API Documentation

Request Syntax

response = client.put_delivery_source(
    name='string',
    resourceArn='string',
    logType='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    A name for this delivery source. This name must be unique for all delivery sources in your account.

  • resourceArn (string) –

    [REQUIRED]

    The ARN of the Amazon Web Services resource that is generating and sending logs. For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234

  • logType (string) –

    [REQUIRED]

    Defines the type of log that the source is sending.

    • For Amazon CodeWhisperer, the valid value is EVENT_LOGS.

    • For IAM Identity Centerr, the valid value is ERROR_LOGS.

    • For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS, and WORKMAIL_MAILBOX_ACCESS_LOGS.

  • tags (dict) –

    An optional list of key-value pairs to associate with the resource.

    For more information about tagging, see Tagging Amazon Web Services resources

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'deliverySource': {
        'name': 'string',
        'arn': 'string',
        'resourceArns': [
            'string',
        ],
        'service': 'string',
        'logType': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • deliverySource (dict) –

      A structure containing information about the delivery source that was just created or updated.

      • name (string) –

        The unique name of the delivery source.

      • arn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies this delivery source.

      • resourceArns (list) –

        This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.

        • (string) –

      • service (string) –

        The Amazon Web Services service that is sending logs.

      • logType (string) –

        The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

      • tags (dict) –

        The tags that have been assigned to this delivery source.

        • (string) –

          • (string) –

Exceptions