AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CloudWatchLogs

import "github.com/aws/aws-sdk-go/service/cloudwatchlogs"

type CloudWatchLogs struct { *client.Client }

CloudWatchLogs provides the API operation methods for making requests to Amazon CloudWatch Logs. See this package's package overview docs for details on the service.

CloudWatchLogs methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

Client

Type: *client.Client

Method

AssociateKmsKey

func (c *CloudWatchLogs) AssociateKmsKey(input *AssociateKmsKeyInput) (*AssociateKmsKeyOutput, error)

AssociateKmsKey API operation for Amazon CloudWatch Logs.

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that it can take up to 5 minutes for this operation to take effect.

If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation AssociateKmsKey for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKey

AssociateKmsKeyRequest

func (c *CloudWatchLogs) AssociateKmsKeyRequest(input *AssociateKmsKeyInput) (req *request.Request, output *AssociateKmsKeyOutput)

AssociateKmsKeyRequest generates a "aws/request.Request" representing the client's request for the AssociateKmsKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateKmsKey for more information on using the AssociateKmsKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateKmsKeyRequest method. req, resp := client.AssociateKmsKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKey

AssociateKmsKeyWithContext

func (c *CloudWatchLogs) AssociateKmsKeyWithContext(ctx aws.Context, input *AssociateKmsKeyInput, opts ...request.Option) (*AssociateKmsKeyOutput, error)

AssociateKmsKeyWithContext is the same as AssociateKmsKey with the addition of the ability to pass a context and additional request options.

See AssociateKmsKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CancelExportTask

func (c *CloudWatchLogs) CancelExportTask(input *CancelExportTaskInput) (*CancelExportTaskOutput, error)

CancelExportTask API operation for Amazon CloudWatch Logs.

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CancelExportTask for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidOperationException "InvalidOperationException" The operation is not valid on the specified resource.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CancelExportTask

CancelExportTaskRequest

func (c *CloudWatchLogs) CancelExportTaskRequest(input *CancelExportTaskInput) (req *request.Request, output *CancelExportTaskOutput)

CancelExportTaskRequest generates a "aws/request.Request" representing the client's request for the CancelExportTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelExportTask for more information on using the CancelExportTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelExportTaskRequest method. req, resp := client.CancelExportTaskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CancelExportTask

CancelExportTaskWithContext

func (c *CloudWatchLogs) CancelExportTaskWithContext(ctx aws.Context, input *CancelExportTaskInput, opts ...request.Option) (*CancelExportTaskOutput, error)

CancelExportTaskWithContext is the same as CancelExportTask with the addition of the ability to pass a context and additional request options.

See CancelExportTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateExportTask

func (c *CloudWatchLogs) CreateExportTask(input *CreateExportTaskInput) (*CreateExportTaskOutput, error)

CreateExportTask API operation for Amazon CloudWatch Logs.

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CreateExportTask for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeLimitExceededException "LimitExceededException" You have reached the maximum number of resources that can be created.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The specified resource already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateExportTask

CreateExportTaskRequest

func (c *CloudWatchLogs) CreateExportTaskRequest(input *CreateExportTaskInput) (req *request.Request, output *CreateExportTaskOutput)

CreateExportTaskRequest generates a "aws/request.Request" representing the client's request for the CreateExportTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateExportTask for more information on using the CreateExportTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateExportTaskRequest method. req, resp := client.CreateExportTaskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateExportTask

CreateExportTaskWithContext

func (c *CloudWatchLogs) CreateExportTaskWithContext(ctx aws.Context, input *CreateExportTaskInput, opts ...request.Option) (*CreateExportTaskOutput, error)

CreateExportTaskWithContext is the same as CreateExportTask with the addition of the ability to pass a context and additional request options.

See CreateExportTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateLogGroup

func (c *CloudWatchLogs) CreateLogGroup(input *CreateLogGroupInput) (*CreateLogGroupOutput, error)

CreateLogGroup API operation for Amazon CloudWatch Logs.

Creates a log group with the specified name.

You can create up to 5000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a region for an AWS account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9,

'_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CreateLogGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The specified resource already exists.

  • ErrCodeLimitExceededException "LimitExceededException" You have reached the maximum number of resources that can be created.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogGroup

CreateLogGroupRequest

func (c *CloudWatchLogs) CreateLogGroupRequest(input *CreateLogGroupInput) (req *request.Request, output *CreateLogGroupOutput)

CreateLogGroupRequest generates a "aws/request.Request" representing the client's request for the CreateLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLogGroup for more information on using the CreateLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLogGroupRequest method. req, resp := client.CreateLogGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogGroup

CreateLogGroupWithContext

func (c *CloudWatchLogs) CreateLogGroupWithContext(ctx aws.Context, input *CreateLogGroupInput, opts ...request.Option) (*CreateLogGroupOutput, error)

CreateLogGroupWithContext is the same as CreateLogGroup with the addition of the ability to pass a context and additional request options.

See CreateLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateLogStream

func (c *CloudWatchLogs) CreateLogStream(input *CreateLogStreamInput) (*CreateLogStreamOutput, error)

CreateLogStream API operation for Amazon CloudWatch Logs.

Creates a log stream for the specified log group.

There is no limit on the number of log streams that you can create for a log group.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • The ':' (colon) and '*' (asterisk) characters are not allowed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CreateLogStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The specified resource already exists.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogStream

CreateLogStreamRequest

func (c *CloudWatchLogs) CreateLogStreamRequest(input *CreateLogStreamInput) (req *request.Request, output *CreateLogStreamOutput)

CreateLogStreamRequest generates a "aws/request.Request" representing the client's request for the CreateLogStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLogStream for more information on using the CreateLogStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLogStreamRequest method. req, resp := client.CreateLogStreamRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogStream

CreateLogStreamWithContext

func (c *CloudWatchLogs) CreateLogStreamWithContext(ctx aws.Context, input *CreateLogStreamInput, opts ...request.Option) (*CreateLogStreamOutput, error)

CreateLogStreamWithContext is the same as CreateLogStream with the addition of the ability to pass a context and additional request options.

See CreateLogStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteDestination

func (c *CloudWatchLogs) DeleteDestination(input *DeleteDestinationInput) (*DeleteDestinationOutput, error)

DeleteDestination API operation for Amazon CloudWatch Logs.

Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteDestination for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDestination

DeleteDestinationRequest

func (c *CloudWatchLogs) DeleteDestinationRequest(input *DeleteDestinationInput) (req *request.Request, output *DeleteDestinationOutput)

DeleteDestinationRequest generates a "aws/request.Request" representing the client's request for the DeleteDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDestination for more information on using the DeleteDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDestinationRequest method. req, resp := client.DeleteDestinationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDestination

DeleteDestinationWithContext

func (c *CloudWatchLogs) DeleteDestinationWithContext(ctx aws.Context, input *DeleteDestinationInput, opts ...request.Option) (*DeleteDestinationOutput, error)

DeleteDestinationWithContext is the same as DeleteDestination with the addition of the ability to pass a context and additional request options.

See DeleteDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteLogGroup

func (c *CloudWatchLogs) DeleteLogGroup(input *DeleteLogGroupInput) (*DeleteLogGroupOutput, error)

DeleteLogGroup API operation for Amazon CloudWatch Logs.

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteLogGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogGroup

DeleteLogGroupRequest

func (c *CloudWatchLogs) DeleteLogGroupRequest(input *DeleteLogGroupInput) (req *request.Request, output *DeleteLogGroupOutput)

DeleteLogGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLogGroup for more information on using the DeleteLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLogGroupRequest method. req, resp := client.DeleteLogGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogGroup

DeleteLogGroupWithContext

func (c *CloudWatchLogs) DeleteLogGroupWithContext(ctx aws.Context, input *DeleteLogGroupInput, opts ...request.Option) (*DeleteLogGroupOutput, error)

DeleteLogGroupWithContext is the same as DeleteLogGroup with the addition of the ability to pass a context and additional request options.

See DeleteLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteLogStream

func (c *CloudWatchLogs) DeleteLogStream(input *DeleteLogStreamInput) (*DeleteLogStreamOutput, error)

DeleteLogStream API operation for Amazon CloudWatch Logs.

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteLogStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogStream

DeleteLogStreamRequest

func (c *CloudWatchLogs) DeleteLogStreamRequest(input *DeleteLogStreamInput) (req *request.Request, output *DeleteLogStreamOutput)

DeleteLogStreamRequest generates a "aws/request.Request" representing the client's request for the DeleteLogStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLogStream for more information on using the DeleteLogStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLogStreamRequest method. req, resp := client.DeleteLogStreamRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogStream

DeleteLogStreamWithContext

func (c *CloudWatchLogs) DeleteLogStreamWithContext(ctx aws.Context, input *DeleteLogStreamInput, opts ...request.Option) (*DeleteLogStreamOutput, error)

DeleteLogStreamWithContext is the same as DeleteLogStream with the addition of the ability to pass a context and additional request options.

See DeleteLogStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteMetricFilter

func (c *CloudWatchLogs) DeleteMetricFilter(input *DeleteMetricFilterInput) (*DeleteMetricFilterOutput, error)

DeleteMetricFilter API operation for Amazon CloudWatch Logs.

Deletes the specified metric filter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteMetricFilter for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteMetricFilter

DeleteMetricFilterRequest

func (c *CloudWatchLogs) DeleteMetricFilterRequest(input *DeleteMetricFilterInput) (req *request.Request, output *DeleteMetricFilterOutput)

DeleteMetricFilterRequest generates a "aws/request.Request" representing the client's request for the DeleteMetricFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMetricFilter for more information on using the DeleteMetricFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteMetricFilterRequest method. req, resp := client.DeleteMetricFilterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteMetricFilter

DeleteMetricFilterWithContext

func (c *CloudWatchLogs) DeleteMetricFilterWithContext(ctx aws.Context, input *DeleteMetricFilterInput, opts ...request.Option) (*DeleteMetricFilterOutput, error)

DeleteMetricFilterWithContext is the same as DeleteMetricFilter with the addition of the ability to pass a context and additional request options.

See DeleteMetricFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteResourcePolicy

func (c *CloudWatchLogs) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error)

DeleteResourcePolicy API operation for Amazon CloudWatch Logs.

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteResourcePolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteResourcePolicy

DeleteResourcePolicyRequest

func (c *CloudWatchLogs) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput)

DeleteResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteResourcePolicy for more information on using the DeleteResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteResourcePolicyRequest method. req, resp := client.DeleteResourcePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteResourcePolicy

DeleteResourcePolicyWithContext

func (c *CloudWatchLogs) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error)

DeleteResourcePolicyWithContext is the same as DeleteResourcePolicy with the addition of the ability to pass a context and additional request options.

See DeleteResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteRetentionPolicy

func (c *CloudWatchLogs) DeleteRetentionPolicy(input *DeleteRetentionPolicyInput) (*DeleteRetentionPolicyOutput, error)

DeleteRetentionPolicy API operation for Amazon CloudWatch Logs.

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteRetentionPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteRetentionPolicy

DeleteRetentionPolicyRequest

func (c *CloudWatchLogs) DeleteRetentionPolicyRequest(input *DeleteRetentionPolicyInput) (req *request.Request, output *DeleteRetentionPolicyOutput)

DeleteRetentionPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteRetentionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRetentionPolicy for more information on using the DeleteRetentionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRetentionPolicyRequest method. req, resp := client.DeleteRetentionPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteRetentionPolicy

DeleteRetentionPolicyWithContext

func (c *CloudWatchLogs) DeleteRetentionPolicyWithContext(ctx aws.Context, input *DeleteRetentionPolicyInput, opts ...request.Option) (*DeleteRetentionPolicyOutput, error)

DeleteRetentionPolicyWithContext is the same as DeleteRetentionPolicy with the addition of the ability to pass a context and additional request options.

See DeleteRetentionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteSubscriptionFilter

func (c *CloudWatchLogs) DeleteSubscriptionFilter(input *DeleteSubscriptionFilterInput) (*DeleteSubscriptionFilterOutput, error)

DeleteSubscriptionFilter API operation for Amazon CloudWatch Logs.

Deletes the specified subscription filter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteSubscriptionFilter for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteSubscriptionFilter

DeleteSubscriptionFilterRequest

func (c *CloudWatchLogs) DeleteSubscriptionFilterRequest(input *DeleteSubscriptionFilterInput) (req *request.Request, output *DeleteSubscriptionFilterOutput)

DeleteSubscriptionFilterRequest generates a "aws/request.Request" representing the client's request for the DeleteSubscriptionFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSubscriptionFilter for more information on using the DeleteSubscriptionFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSubscriptionFilterRequest method. req, resp := client.DeleteSubscriptionFilterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteSubscriptionFilter

DeleteSubscriptionFilterWithContext

func (c *CloudWatchLogs) DeleteSubscriptionFilterWithContext(ctx aws.Context, input *DeleteSubscriptionFilterInput, opts ...request.Option) (*DeleteSubscriptionFilterOutput, error)

DeleteSubscriptionFilterWithContext is the same as DeleteSubscriptionFilter with the addition of the ability to pass a context and additional request options.

See DeleteSubscriptionFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeDestinations

func (c *CloudWatchLogs) DescribeDestinations(input *DescribeDestinationsInput) (*DescribeDestinationsOutput, error)

DescribeDestinations API operation for Amazon CloudWatch Logs.

Lists all your destinations. The results are ASCII-sorted by destination name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeDestinations for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDestinations

DescribeDestinationsPages

func (c *CloudWatchLogs) DescribeDestinationsPages(input *DescribeDestinationsInput, fn func(*DescribeDestinationsOutput, bool) bool) error

DescribeDestinationsPages iterates over the pages of a DescribeDestinations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDestinations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDestinations operation. pageNum := 0 err := client.DescribeDestinationsPages(params, func(page *DescribeDestinationsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

DescribeDestinationsPagesWithContext

func (c *CloudWatchLogs) DescribeDestinationsPagesWithContext(ctx aws.Context, input *DescribeDestinationsInput, fn func(*DescribeDestinationsOutput, bool) bool, opts ...request.Option) error

DescribeDestinationsPagesWithContext same as DescribeDestinationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeDestinationsRequest

func (c *CloudWatchLogs) DescribeDestinationsRequest(input *DescribeDestinationsInput) (req *request.Request, output *DescribeDestinationsOutput)

DescribeDestinationsRequest generates a "aws/request.Request" representing the client's request for the DescribeDestinations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDestinations for more information on using the DescribeDestinations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDestinationsRequest method. req, resp := client.DescribeDestinationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDestinations

DescribeDestinationsWithContext

func (c *CloudWatchLogs) DescribeDestinationsWithContext(ctx aws.Context, input *DescribeDestinationsInput, opts ...request.Option) (*DescribeDestinationsOutput, error)

DescribeDestinationsWithContext is the same as DescribeDestinations with the addition of the ability to pass a context and additional request options.

See DescribeDestinations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeExportTasks

func (c *CloudWatchLogs) DescribeExportTasks(input *DescribeExportTasksInput) (*DescribeExportTasksOutput, error)

DescribeExportTasks API operation for Amazon CloudWatch Logs.

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeExportTasks for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeExportTasks

DescribeExportTasksRequest

func (c *CloudWatchLogs) DescribeExportTasksRequest(input *DescribeExportTasksInput) (req *request.Request, output *DescribeExportTasksOutput)

DescribeExportTasksRequest generates a "aws/request.Request" representing the client's request for the DescribeExportTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExportTasks for more information on using the DescribeExportTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeExportTasksRequest method. req, resp := client.DescribeExportTasksRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeExportTasks

DescribeExportTasksWithContext

func (c *CloudWatchLogs) DescribeExportTasksWithContext(ctx aws.Context, input *DescribeExportTasksInput, opts ...request.Option) (*DescribeExportTasksOutput, error)

DescribeExportTasksWithContext is the same as DescribeExportTasks with the addition of the ability to pass a context and additional request options.

See DescribeExportTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeLogGroups

func (c *CloudWatchLogs) DescribeLogGroups(input *DescribeLogGroupsInput) (*DescribeLogGroupsOutput, error)

DescribeLogGroups API operation for Amazon CloudWatch Logs.

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeLogGroups for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogGroups

DescribeLogGroupsPages

func (c *CloudWatchLogs) DescribeLogGroupsPages(input *DescribeLogGroupsInput, fn func(*DescribeLogGroupsOutput, bool) bool) error

DescribeLogGroupsPages iterates over the pages of a DescribeLogGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeLogGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeLogGroups operation. pageNum := 0 err := client.DescribeLogGroupsPages(params, func(page *DescribeLogGroupsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

DescribeLogGroupsPagesWithContext

func (c *CloudWatchLogs) DescribeLogGroupsPagesWithContext(ctx aws.Context, input *DescribeLogGroupsInput, fn func(*DescribeLogGroupsOutput, bool) bool, opts ...request.Option) error

DescribeLogGroupsPagesWithContext same as DescribeLogGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeLogGroupsRequest

func (c *CloudWatchLogs) DescribeLogGroupsRequest(input *DescribeLogGroupsInput) (req *request.Request, output *DescribeLogGroupsOutput)

DescribeLogGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeLogGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLogGroups for more information on using the DescribeLogGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLogGroupsRequest method. req, resp := client.DescribeLogGroupsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogGroups

DescribeLogGroupsWithContext

func (c *CloudWatchLogs) DescribeLogGroupsWithContext(ctx aws.Context, input *DescribeLogGroupsInput, opts ...request.Option) (*DescribeLogGroupsOutput, error)

DescribeLogGroupsWithContext is the same as DescribeLogGroups with the addition of the ability to pass a context and additional request options.

See DescribeLogGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeLogStreams

func (c *CloudWatchLogs) DescribeLogStreams(input *DescribeLogStreamsInput) (*DescribeLogStreamsOutput, error)

DescribeLogStreams API operation for Amazon CloudWatch Logs.

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeLogStreams for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogStreams

DescribeLogStreamsPages

func (c *CloudWatchLogs) DescribeLogStreamsPages(input *DescribeLogStreamsInput, fn func(*DescribeLogStreamsOutput, bool) bool) error

DescribeLogStreamsPages iterates over the pages of a DescribeLogStreams operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeLogStreams method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeLogStreams operation. pageNum := 0 err := client.DescribeLogStreamsPages(params, func(page *DescribeLogStreamsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

DescribeLogStreamsPagesWithContext

func (c *CloudWatchLogs) DescribeLogStreamsPagesWithContext(ctx aws.Context, input *DescribeLogStreamsInput, fn func(*DescribeLogStreamsOutput, bool) bool, opts ...request.Option) error

DescribeLogStreamsPagesWithContext same as DescribeLogStreamsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeLogStreamsRequest

func (c *CloudWatchLogs) DescribeLogStreamsRequest(input *DescribeLogStreamsInput) (req *request.Request, output *DescribeLogStreamsOutput)

DescribeLogStreamsRequest generates a "aws/request.Request" representing the client's request for the DescribeLogStreams operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLogStreams for more information on using the DescribeLogStreams API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLogStreamsRequest method. req, resp := client.DescribeLogStreamsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogStreams

DescribeLogStreamsWithContext

func (c *CloudWatchLogs) DescribeLogStreamsWithContext(ctx aws.Context, input *DescribeLogStreamsInput, opts ...request.Option) (*DescribeLogStreamsOutput, error)

DescribeLogStreamsWithContext is the same as DescribeLogStreams with the addition of the ability to pass a context and additional request options.

See DescribeLogStreams for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeMetricFilters

func (c *CloudWatchLogs) DescribeMetricFilters(input *DescribeMetricFiltersInput) (*DescribeMetricFiltersOutput, error)

DescribeMetricFilters API operation for Amazon CloudWatch Logs.

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeMetricFilters for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeMetricFilters

DescribeMetricFiltersPages

func (c *CloudWatchLogs) DescribeMetricFiltersPages(input *DescribeMetricFiltersInput, fn func(*DescribeMetricFiltersOutput, bool) bool) error

DescribeMetricFiltersPages iterates over the pages of a DescribeMetricFilters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeMetricFilters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeMetricFilters operation. pageNum := 0 err := client.DescribeMetricFiltersPages(params, func(page *DescribeMetricFiltersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

DescribeMetricFiltersPagesWithContext

func (c *CloudWatchLogs) DescribeMetricFiltersPagesWithContext(ctx aws.Context, input *DescribeMetricFiltersInput, fn func(*DescribeMetricFiltersOutput, bool) bool, opts ...request.Option) error

DescribeMetricFiltersPagesWithContext same as DescribeMetricFiltersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeMetricFiltersRequest

func (c *CloudWatchLogs) DescribeMetricFiltersRequest(input *DescribeMetricFiltersInput) (req *request.Request, output *DescribeMetricFiltersOutput)

DescribeMetricFiltersRequest generates a "aws/request.Request" representing the client's request for the DescribeMetricFilters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMetricFilters for more information on using the DescribeMetricFilters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMetricFiltersRequest method. req, resp := client.DescribeMetricFiltersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeMetricFilters

DescribeMetricFiltersWithContext

func (c *CloudWatchLogs) DescribeMetricFiltersWithContext(ctx aws.Context, input *DescribeMetricFiltersInput, opts ...request.Option) (*DescribeMetricFiltersOutput, error)

DescribeMetricFiltersWithContext is the same as DescribeMetricFilters with the addition of the ability to pass a context and additional request options.

See DescribeMetricFilters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeQueries

func (c *CloudWatchLogs) DescribeQueries(input *DescribeQueriesInput) (*DescribeQueriesOutput, error)

DescribeQueries API operation for Amazon CloudWatch Logs.

Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries, or limit it to queries of a specific log group or queries with a certain status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeQueries for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueries

DescribeQueriesRequest

func (c *CloudWatchLogs) DescribeQueriesRequest(input *DescribeQueriesInput) (req *request.Request, output *DescribeQueriesOutput)

DescribeQueriesRequest generates a "aws/request.Request" representing the client's request for the DescribeQueries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQueries for more information on using the DescribeQueries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeQueriesRequest method. req, resp := client.DescribeQueriesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueries

DescribeQueriesWithContext

func (c *CloudWatchLogs) DescribeQueriesWithContext(ctx aws.Context, input *DescribeQueriesInput, opts ...request.Option) (*DescribeQueriesOutput, error)

DescribeQueriesWithContext is the same as DescribeQueries with the addition of the ability to pass a context and additional request options.

See DescribeQueries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeResourcePolicies

func (c *CloudWatchLogs) DescribeResourcePolicies(input *DescribeResourcePoliciesInput) (*DescribeResourcePoliciesOutput, error)

DescribeResourcePolicies API operation for Amazon CloudWatch Logs.

Lists the resource policies in this account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeResourcePolicies for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeResourcePolicies

DescribeResourcePoliciesRequest

func (c *CloudWatchLogs) DescribeResourcePoliciesRequest(input *DescribeResourcePoliciesInput) (req *request.Request, output *DescribeResourcePoliciesOutput)

DescribeResourcePoliciesRequest generates a "aws/request.Request" representing the client's request for the DescribeResourcePolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeResourcePolicies for more information on using the DescribeResourcePolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeResourcePoliciesRequest method. req, resp := client.DescribeResourcePoliciesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeResourcePolicies

DescribeResourcePoliciesWithContext

func (c *CloudWatchLogs) DescribeResourcePoliciesWithContext(ctx aws.Context, input *DescribeResourcePoliciesInput, opts ...request.Option) (*DescribeResourcePoliciesOutput, error)

DescribeResourcePoliciesWithContext is the same as DescribeResourcePolicies with the addition of the ability to pass a context and additional request options.

See DescribeResourcePolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeSubscriptionFilters

func (c *CloudWatchLogs) DescribeSubscriptionFilters(input *DescribeSubscriptionFiltersInput) (*DescribeSubscriptionFiltersOutput, error)

DescribeSubscriptionFilters API operation for Amazon CloudWatch Logs.

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeSubscriptionFilters for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeSubscriptionFilters

DescribeSubscriptionFiltersPages

func (c *CloudWatchLogs) DescribeSubscriptionFiltersPages(input *DescribeSubscriptionFiltersInput, fn func(*DescribeSubscriptionFiltersOutput, bool) bool) error

DescribeSubscriptionFiltersPages iterates over the pages of a DescribeSubscriptionFilters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeSubscriptionFilters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeSubscriptionFilters operation. pageNum := 0 err := client.DescribeSubscriptionFiltersPages(params, func(page *DescribeSubscriptionFiltersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

DescribeSubscriptionFiltersPagesWithContext

func (c *CloudWatchLogs) DescribeSubscriptionFiltersPagesWithContext(ctx aws.Context, input *DescribeSubscriptionFiltersInput, fn func(*DescribeSubscriptionFiltersOutput, bool) bool, opts ...request.Option) error

DescribeSubscriptionFiltersPagesWithContext same as DescribeSubscriptionFiltersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DescribeSubscriptionFiltersRequest

func (c *CloudWatchLogs) DescribeSubscriptionFiltersRequest(input *DescribeSubscriptionFiltersInput) (req *request.Request, output *DescribeSubscriptionFiltersOutput)

DescribeSubscriptionFiltersRequest generates a "aws/request.Request" representing the client's request for the DescribeSubscriptionFilters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSubscriptionFilters for more information on using the DescribeSubscriptionFilters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSubscriptionFiltersRequest method. req, resp := client.DescribeSubscriptionFiltersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeSubscriptionFilters

DescribeSubscriptionFiltersWithContext

func (c *CloudWatchLogs) DescribeSubscriptionFiltersWithContext(ctx aws.Context, input *DescribeSubscriptionFiltersInput, opts ...request.Option) (*DescribeSubscriptionFiltersOutput, error)

DescribeSubscriptionFiltersWithContext is the same as DescribeSubscriptionFilters with the addition of the ability to pass a context and additional request options.

See DescribeSubscriptionFilters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DisassociateKmsKey

func (c *CloudWatchLogs) DisassociateKmsKey(input *DisassociateKmsKeyInput) (*DisassociateKmsKeyOutput, error)

DisassociateKmsKey API operation for Amazon CloudWatch Logs.

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

Note that it can take up to 5 minutes for this operation to take effect.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DisassociateKmsKey for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKey

DisassociateKmsKeyRequest

func (c *CloudWatchLogs) DisassociateKmsKeyRequest(input *DisassociateKmsKeyInput) (req *request.Request, output *DisassociateKmsKeyOutput)

DisassociateKmsKeyRequest generates a "aws/request.Request" representing the client's request for the DisassociateKmsKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateKmsKey for more information on using the DisassociateKmsKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateKmsKeyRequest method. req, resp := client.DisassociateKmsKeyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKey

DisassociateKmsKeyWithContext

func (c *CloudWatchLogs) DisassociateKmsKeyWithContext(ctx aws.Context, input *DisassociateKmsKeyInput, opts ...request.Option) (*DisassociateKmsKeyOutput, error)

DisassociateKmsKeyWithContext is the same as DisassociateKmsKey with the addition of the ability to pass a context and additional request options.

See DisassociateKmsKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

FilterLogEvents

func (c *CloudWatchLogs) FilterLogEvents(input *FilterLogEventsInput) (*FilterLogEventsOutput, error)

FilterLogEvents API operation for Amazon CloudWatch Logs.

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation FilterLogEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEvents

FilterLogEventsPages

func (c *CloudWatchLogs) FilterLogEventsPages(input *FilterLogEventsInput, fn func(*FilterLogEventsOutput, bool) bool) error

FilterLogEventsPages iterates over the pages of a FilterLogEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See FilterLogEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a FilterLogEvents operation. pageNum := 0 err := client.FilterLogEventsPages(params, func(page *FilterLogEventsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

FilterLogEventsPagesWithContext

func (c *CloudWatchLogs) FilterLogEventsPagesWithContext(ctx aws.Context, input *FilterLogEventsInput, fn func(*FilterLogEventsOutput, bool) bool, opts ...request.Option) error

FilterLogEventsPagesWithContext same as FilterLogEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

FilterLogEventsRequest

func (c *CloudWatchLogs) FilterLogEventsRequest(input *FilterLogEventsInput) (req *request.Request, output *FilterLogEventsOutput)

FilterLogEventsRequest generates a "aws/request.Request" representing the client's request for the FilterLogEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See FilterLogEvents for more information on using the FilterLogEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the FilterLogEventsRequest method. req, resp := client.FilterLogEventsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEvents

FilterLogEventsWithContext

func (c *CloudWatchLogs) FilterLogEventsWithContext(ctx aws.Context, input *FilterLogEventsInput, opts ...request.Option) (*FilterLogEventsOutput, error)

FilterLogEventsWithContext is the same as FilterLogEvents with the addition of the ability to pass a context and additional request options.

See FilterLogEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLogEvents

func (c *CloudWatchLogs) GetLogEvents(input *GetLogEventsInput) (*GetLogEventsOutput, error)

GetLogEvents API operation for Amazon CloudWatch Logs.

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetLogEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogEvents

GetLogEventsPages

func (c *CloudWatchLogs) GetLogEventsPages(input *GetLogEventsInput, fn func(*GetLogEventsOutput, bool) bool) error

GetLogEventsPages iterates over the pages of a GetLogEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetLogEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetLogEvents operation. pageNum := 0 err := client.GetLogEventsPages(params, func(page *GetLogEventsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

GetLogEventsPagesWithContext

func (c *CloudWatchLogs) GetLogEventsPagesWithContext(ctx aws.Context, input *GetLogEventsInput, fn func(*GetLogEventsOutput, bool) bool, opts ...request.Option) error

GetLogEventsPagesWithContext same as GetLogEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLogEventsRequest

func (c *CloudWatchLogs) GetLogEventsRequest(input *GetLogEventsInput) (req *request.Request, output *GetLogEventsOutput)

GetLogEventsRequest generates a "aws/request.Request" representing the client's request for the GetLogEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLogEvents for more information on using the GetLogEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLogEventsRequest method. req, resp := client.GetLogEventsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogEvents

GetLogEventsWithContext

func (c *CloudWatchLogs) GetLogEventsWithContext(ctx aws.Context, input *GetLogEventsInput, opts ...request.Option) (*GetLogEventsOutput, error)

GetLogEventsWithContext is the same as GetLogEvents with the addition of the ability to pass a context and additional request options.

See GetLogEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLogGroupFields

func (c *CloudWatchLogs) GetLogGroupFields(input *GetLogGroupFieldsInput) (*GetLogGroupFieldsOutput, error)

GetLogGroupFields API operation for Amazon CloudWatch Logs.

Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event.

The response results are sorted by the frequency percentage, starting with the highest percentage.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetLogGroupFields for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeLimitExceededException "LimitExceededException" You have reached the maximum number of resources that can be created.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFields

GetLogGroupFieldsRequest

func (c *CloudWatchLogs) GetLogGroupFieldsRequest(input *GetLogGroupFieldsInput) (req *request.Request, output *GetLogGroupFieldsOutput)

GetLogGroupFieldsRequest generates a "aws/request.Request" representing the client's request for the GetLogGroupFields operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLogGroupFields for more information on using the GetLogGroupFields API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLogGroupFieldsRequest method. req, resp := client.GetLogGroupFieldsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFields

GetLogGroupFieldsWithContext

func (c *CloudWatchLogs) GetLogGroupFieldsWithContext(ctx aws.Context, input *GetLogGroupFieldsInput, opts ...request.Option) (*GetLogGroupFieldsOutput, error)

GetLogGroupFieldsWithContext is the same as GetLogGroupFields with the addition of the ability to pass a context and additional request options.

See GetLogGroupFields for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetLogRecord

func (c *CloudWatchLogs) GetLogRecord(input *GetLogRecordInput) (*GetLogRecordOutput, error)

GetLogRecord API operation for Amazon CloudWatch Logs.

Retrieves all the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

Additionally, the entire unparsed log event is returned within @message.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetLogRecord for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeLimitExceededException "LimitExceededException" You have reached the maximum number of resources that can be created.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecord

GetLogRecordRequest

func (c *CloudWatchLogs) GetLogRecordRequest(input *GetLogRecordInput) (req *request.Request, output *GetLogRecordOutput)

GetLogRecordRequest generates a "aws/request.Request" representing the client's request for the GetLogRecord operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLogRecord for more information on using the GetLogRecord API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLogRecordRequest method. req, resp := client.GetLogRecordRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecord

GetLogRecordWithContext

func (c *CloudWatchLogs) GetLogRecordWithContext(ctx aws.Context, input *GetLogRecordInput, opts ...request.Option) (*GetLogRecordOutput, error)

GetLogRecordWithContext is the same as GetLogRecord with the addition of the ability to pass a context and additional request options.

See GetLogRecord for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetQueryResults

func (c *CloudWatchLogs) GetQueryResults(input *GetQueryResultsInput) (*GetQueryResultsOutput, error)

GetQueryResults API operation for Amazon CloudWatch Logs.

Returns the results from the specified query. If the query is in progress, partial results of that current execution are returned. Only the fields requested in the query are returned.

GetQueryResults does not start a query execution. To run a query, use .

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetQueryResults for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResults

GetQueryResultsRequest

func (c *CloudWatchLogs) GetQueryResultsRequest(input *GetQueryResultsInput) (req *request.Request, output *GetQueryResultsOutput)

GetQueryResultsRequest generates a "aws/request.Request" representing the client's request for the GetQueryResults operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQueryResults for more information on using the GetQueryResults API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetQueryResultsRequest method. req, resp := client.GetQueryResultsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResults

GetQueryResultsWithContext

func (c *CloudWatchLogs) GetQueryResultsWithContext(ctx aws.Context, input *GetQueryResultsInput, opts ...request.Option) (*GetQueryResultsOutput, error)

GetQueryResultsWithContext is the same as GetQueryResults with the addition of the ability to pass a context and additional request options.

See GetQueryResults for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListTagsLogGroup

func (c *CloudWatchLogs) ListTagsLogGroup(input *ListTagsLogGroupInput) (*ListTagsLogGroupOutput, error)

ListTagsLogGroup API operation for Amazon CloudWatch Logs.

Lists the tags for the specified log group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation ListTagsLogGroup for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsLogGroup

ListTagsLogGroupRequest

func (c *CloudWatchLogs) ListTagsLogGroupRequest(input *ListTagsLogGroupInput) (req *request.Request, output *ListTagsLogGroupOutput)

ListTagsLogGroupRequest generates a "aws/request.Request" representing the client's request for the ListTagsLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsLogGroup for more information on using the ListTagsLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsLogGroupRequest method. req, resp := client.ListTagsLogGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsLogGroup

ListTagsLogGroupWithContext

func (c *CloudWatchLogs) ListTagsLogGroupWithContext(ctx aws.Context, input *ListTagsLogGroupInput, opts ...request.Option) (*ListTagsLogGroupOutput, error)

ListTagsLogGroupWithContext is the same as ListTagsLogGroup with the addition of the ability to pass a context and additional request options.

See ListTagsLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutDestination

func (c *CloudWatchLogs) PutDestination(input *PutDestinationInput) (*PutDestinationOutput, error)

PutDestination API operation for Amazon CloudWatch Logs.

Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.

Through an access policy, a destination controls what is written to its Kinesis stream. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutDestination for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestination

PutDestinationPolicy

func (c *CloudWatchLogs) PutDestinationPolicy(input *PutDestinationPolicyInput) (*PutDestinationPolicyOutput, error)

PutDestinationPolicy API operation for Amazon CloudWatch Logs.

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html) that is used to authorize claims to register a subscription filter against a given destination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutDestinationPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestinationPolicy

PutDestinationPolicyRequest

func (c *CloudWatchLogs) PutDestinationPolicyRequest(input *PutDestinationPolicyInput) (req *request.Request, output *PutDestinationPolicyOutput)

PutDestinationPolicyRequest generates a "aws/request.Request" representing the client's request for the PutDestinationPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDestinationPolicy for more information on using the PutDestinationPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDestinationPolicyRequest method. req, resp := client.PutDestinationPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestinationPolicy

PutDestinationPolicyWithContext

func (c *CloudWatchLogs) PutDestinationPolicyWithContext(ctx aws.Context, input *PutDestinationPolicyInput, opts ...request.Option) (*PutDestinationPolicyOutput, error)

PutDestinationPolicyWithContext is the same as PutDestinationPolicy with the addition of the ability to pass a context and additional request options.

See PutDestinationPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutDestinationRequest

func (c *CloudWatchLogs) PutDestinationRequest(input *PutDestinationInput) (req *request.Request, output *PutDestinationOutput)

PutDestinationRequest generates a "aws/request.Request" representing the client's request for the PutDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDestination for more information on using the PutDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDestinationRequest method. req, resp := client.PutDestinationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestination

PutDestinationWithContext

func (c *CloudWatchLogs) PutDestinationWithContext(ctx aws.Context, input *PutDestinationInput, opts ...request.Option) (*PutDestinationOutput, error)

PutDestinationWithContext is the same as PutDestination with the addition of the ability to pass a context and additional request options.

See PutDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutLogEvents

func (c *CloudWatchLogs) PutLogEvents(input *PutLogEventsInput) (*PutLogEventsOutput, error)

PutLogEvents API operation for Amazon CloudWatch Logs.

Uploads a batch of log events to the specified log stream.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be older than 14 days or the retention period of the log group.

  • The log events in the batch must be in chronological ordered by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

  • The maximum number of log events in a batch is 10,000.

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutLogEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeInvalidSequenceTokenException "InvalidSequenceTokenException" The sequence token is not valid.

  • ErrCodeDataAlreadyAcceptedException "DataAlreadyAcceptedException" The event was already logged.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

  • ErrCodeUnrecognizedClientException "UnrecognizedClientException" The most likely cause is an invalid AWS access key ID or secret key.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEvents

PutLogEventsRequest

func (c *CloudWatchLogs) PutLogEventsRequest(input *PutLogEventsInput) (req *request.Request, output *PutLogEventsOutput)

PutLogEventsRequest generates a "aws/request.Request" representing the client's request for the PutLogEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutLogEvents for more information on using the PutLogEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutLogEventsRequest method. req, resp := client.PutLogEventsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEvents

PutLogEventsWithContext

func (c *CloudWatchLogs) PutLogEventsWithContext(ctx aws.Context, input *PutLogEventsInput, opts ...request.Option) (*PutLogEventsOutput, error)

PutLogEventsWithContext is the same as PutLogEvents with the addition of the ability to pass a context and additional request options.

See PutLogEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutMetricFilter

func (c *CloudWatchLogs) PutMetricFilter(input *PutMetricFilterInput) (*PutMetricFilterOutput, error)

PutMetricFilter API operation for Amazon CloudWatch Logs.

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutMetricFilter for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeLimitExceededException "LimitExceededException" You have reached the maximum number of resources that can be created.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutMetricFilter

PutMetricFilterRequest

func (c *CloudWatchLogs) PutMetricFilterRequest(input *PutMetricFilterInput) (req *request.Request, output *PutMetricFilterOutput)

PutMetricFilterRequest generates a "aws/request.Request" representing the client's request for the PutMetricFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutMetricFilter for more information on using the PutMetricFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutMetricFilterRequest method. req, resp := client.PutMetricFilterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutMetricFilter

PutMetricFilterWithContext

func (c *CloudWatchLogs) PutMetricFilterWithContext(ctx aws.Context, input *PutMetricFilterInput, opts ...request.Option) (*PutMetricFilterOutput, error)

PutMetricFilterWithContext is the same as PutMetricFilter with the addition of the ability to pass a context and additional request options.

See PutMetricFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutResourcePolicy

func (c *CloudWatchLogs) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error)

PutResourcePolicy API operation for Amazon CloudWatch Logs.

Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutResourcePolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeLimitExceededException "LimitExceededException" You have reached the maximum number of resources that can be created.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutResourcePolicy

PutResourcePolicyRequest

func (c *CloudWatchLogs) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput)

PutResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the PutResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutResourcePolicy for more information on using the PutResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutResourcePolicyRequest method. req, resp := client.PutResourcePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutResourcePolicy

PutResourcePolicyWithContext

func (c *CloudWatchLogs) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error)

PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of the ability to pass a context and additional request options.

See PutResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutRetentionPolicy

func (c *CloudWatchLogs) PutRetentionPolicy(input *PutRetentionPolicyInput) (*PutRetentionPolicyOutput, error)

PutRetentionPolicy API operation for Amazon CloudWatch Logs.

Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutRetentionPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutRetentionPolicy

PutRetentionPolicyRequest

func (c *CloudWatchLogs) PutRetentionPolicyRequest(input *PutRetentionPolicyInput) (req *request.Request, output *PutRetentionPolicyOutput)

PutRetentionPolicyRequest generates a "aws/request.Request" representing the client's request for the PutRetentionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutRetentionPolicy for more information on using the PutRetentionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutRetentionPolicyRequest method. req, resp := client.PutRetentionPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutRetentionPolicy

PutRetentionPolicyWithContext

func (c *CloudWatchLogs) PutRetentionPolicyWithContext(ctx aws.Context, input *PutRetentionPolicyInput, opts ...request.Option) (*PutRetentionPolicyOutput, error)

PutRetentionPolicyWithContext is the same as PutRetentionPolicy with the addition of the ability to pass a context and additional request options.

See PutRetentionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

PutSubscriptionFilter

func (c *CloudWatchLogs) PutSubscriptionFilter(input *PutSubscriptionFilterInput) (*PutSubscriptionFilterOutput, error)

PutSubscriptionFilter API operation for Amazon CloudWatch Logs.

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutSubscriptionFilter for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeOperationAbortedException "OperationAbortedException" Multiple requests to update the same resource were in conflict.

  • ErrCodeLimitExceededException "LimitExceededException" You have reached the maximum number of resources that can be created.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutSubscriptionFilter

PutSubscriptionFilterRequest

func (c *CloudWatchLogs) PutSubscriptionFilterRequest(input *PutSubscriptionFilterInput) (req *request.Request, output *PutSubscriptionFilterOutput)

PutSubscriptionFilterRequest generates a "aws/request.Request" representing the client's request for the PutSubscriptionFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutSubscriptionFilter for more information on using the PutSubscriptionFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutSubscriptionFilterRequest method. req, resp := client.PutSubscriptionFilterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutSubscriptionFilter

PutSubscriptionFilterWithContext

func (c *CloudWatchLogs) PutSubscriptionFilterWithContext(ctx aws.Context, input *PutSubscriptionFilterInput, opts ...request.Option) (*PutSubscriptionFilterOutput, error)

PutSubscriptionFilterWithContext is the same as PutSubscriptionFilter with the addition of the ability to pass a context and additional request options.

See PutSubscriptionFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

StartQuery

func (c *CloudWatchLogs) StartQuery(input *StartQueryInput) (*StartQueryOutput, error)

StartQuery API operation for Amazon CloudWatch Logs.

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query, and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation StartQuery for usage and error information.

Returned Error Codes:

  • ErrCodeMalformedQueryException "MalformedQueryException" The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see .

For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax (http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).
  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeLimitExceededException "LimitExceededException" You have reached the maximum number of resources that can be created.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQuery

StartQueryRequest

func (c *CloudWatchLogs) StartQueryRequest(input *StartQueryInput) (req *request.Request, output *StartQueryOutput)

StartQueryRequest generates a "aws/request.Request" representing the client's request for the StartQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartQuery for more information on using the StartQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartQueryRequest method. req, resp := client.StartQueryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQuery

StartQueryWithContext

func (c *CloudWatchLogs) StartQueryWithContext(ctx aws.Context, input *StartQueryInput, opts ...request.Option) (*StartQueryOutput, error)

StartQueryWithContext is the same as StartQuery with the addition of the ability to pass a context and additional request options.

See StartQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

StopQuery

func (c *CloudWatchLogs) StopQuery(input *StopQueryInput) (*StopQueryOutput, error)

StopQuery API operation for Amazon CloudWatch Logs.

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation StopQuery for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQuery

StopQueryRequest

func (c *CloudWatchLogs) StopQueryRequest(input *StopQueryInput) (req *request.Request, output *StopQueryOutput)

StopQueryRequest generates a "aws/request.Request" representing the client's request for the StopQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopQuery for more information on using the StopQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopQueryRequest method. req, resp := client.StopQueryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQuery

StopQueryWithContext

func (c *CloudWatchLogs) StopQueryWithContext(ctx aws.Context, input *StopQueryInput, opts ...request.Option) (*StopQueryOutput, error)

StopQueryWithContext is the same as StopQuery with the addition of the ability to pass a context and additional request options.

See StopQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

TagLogGroup

func (c *CloudWatchLogs) TagLogGroup(input *TagLogGroupInput) (*TagLogGroupOutput, error)

TagLogGroup API operation for Amazon CloudWatch Logs.

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/log-group-tagging.html) in the Amazon CloudWatch Logs User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation TagLogGroup for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TagLogGroup

TagLogGroupRequest

func (c *CloudWatchLogs) TagLogGroupRequest(input *TagLogGroupInput) (req *request.Request, output *TagLogGroupOutput)

TagLogGroupRequest generates a "aws/request.Request" representing the client's request for the TagLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagLogGroup for more information on using the TagLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagLogGroupRequest method. req, resp := client.TagLogGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TagLogGroup

TagLogGroupWithContext

func (c *CloudWatchLogs) TagLogGroupWithContext(ctx aws.Context, input *TagLogGroupInput, opts ...request.Option) (*TagLogGroupOutput, error)

TagLogGroupWithContext is the same as TagLogGroup with the addition of the ability to pass a context and additional request options.

See TagLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

TestMetricFilter

func (c *CloudWatchLogs) TestMetricFilter(input *TestMetricFilterInput) (*TestMetricFilterOutput, error)

TestMetricFilter API operation for Amazon CloudWatch Logs.

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation TestMetricFilter for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter is specified incorrectly.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TestMetricFilter

TestMetricFilterRequest

func (c *CloudWatchLogs) TestMetricFilterRequest(input *TestMetricFilterInput) (req *request.Request, output *TestMetricFilterOutput)

TestMetricFilterRequest generates a "aws/request.Request" representing the client's request for the TestMetricFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestMetricFilter for more information on using the TestMetricFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TestMetricFilterRequest method. req, resp := client.TestMetricFilterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TestMetricFilter

TestMetricFilterWithContext

func (c *CloudWatchLogs) TestMetricFilterWithContext(ctx aws.Context, input *TestMetricFilterInput, opts ...request.Option) (*TestMetricFilterOutput, error)

TestMetricFilterWithContext is the same as TestMetricFilter with the addition of the ability to pass a context and additional request options.

See TestMetricFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UntagLogGroup

func (c *CloudWatchLogs) UntagLogGroup(input *UntagLogGroupInput) (*UntagLogGroupOutput, error)

UntagLogGroup API operation for Amazon CloudWatch Logs.

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation UntagLogGroup for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UntagLogGroup

UntagLogGroupRequest

func (c *CloudWatchLogs) UntagLogGroupRequest(input *UntagLogGroupInput) (req *request.Request, output *UntagLogGroupOutput)

UntagLogGroupRequest generates a "aws/request.Request" representing the client's request for the UntagLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagLogGroup for more information on using the UntagLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagLogGroupRequest method. req, resp := client.UntagLogGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UntagLogGroup

UntagLogGroupWithContext

func (c *CloudWatchLogs) UntagLogGroupWithContext(ctx aws.Context, input *UntagLogGroupInput, opts ...request.Option) (*UntagLogGroupOutput, error)

UntagLogGroupWithContext is the same as UntagLogGroup with the addition of the ability to pass a context and additional request options.

See UntagLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

On this page: