oam

package
v1.55.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 24, 2024 License: Apache-2.0 Imports: 9 Imported by: 16

Documentation

Overview

Package oam provides the client and types for making API requests to CloudWatch Observability Access Manager.

Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.

Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.

See https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10 for more information on this service.

See oam package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/oam/

Using the Client

To contact CloudWatch Observability Access Manager with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the CloudWatch Observability Access Manager client OAM for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/oam/#New

Index

Constants

View Source 
const (
	// ResourceTypeAwsCloudWatchMetric is a ResourceType enum value
	ResourceTypeAwsCloudWatchMetric = "AWS::CloudWatch::Metric"

	// ResourceTypeAwsLogsLogGroup is a ResourceType enum value
	ResourceTypeAwsLogsLogGroup = "AWS::Logs::LogGroup"

	// ResourceTypeAwsXrayTrace is a ResourceType enum value
	ResourceTypeAwsXrayTrace = "AWS::XRay::Trace"

	// ResourceTypeAwsApplicationInsightsApplication is a ResourceType enum value
	ResourceTypeAwsApplicationInsightsApplication = "AWS::ApplicationInsights::Application"

	// ResourceTypeAwsInternetMonitorMonitor is a ResourceType enum value
	ResourceTypeAwsInternetMonitorMonitor = "AWS::InternetMonitor::Monitor"
)
View Source 
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A resource was in an inconsistent state during an update or a deletion.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServiceFault for service response error code
	// "InternalServiceFault".
	//
	// Unexpected error while processing the request. Retry the request.
	ErrCodeInternalServiceFault = "InternalServiceFault"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// A parameter is specified incorrectly.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeMissingRequiredParameterException for service response error code
	// "MissingRequiredParameterException".
	//
	// A required parameter is missing from the request.
	ErrCodeMissingRequiredParameterException = "MissingRequiredParameterException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The request references a resource that does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request would cause a service quota to be exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// A resource can have no more than 50 tags.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The value of a parameter in the request caused an error.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "OAM" // Name of service.
	EndpointsID = "oam" // ID to lookup a service endpoint with.
	ServiceID   = "OAM" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ResourceType_Values 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

Types

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The name of the exception.
	AmznErrorType *string `location:"header" locationName:"x-amzn-ErrorType" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

A resource was in an inconsistent state during an update or a deletion.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLinkInput 

type CreateLinkInput struct {

	// Specify a friendly human-readable name to use to identify this source account
	// when you are viewing data from it in the monitoring account.
	//
	// You can use a custom label or use the following variables:
	//
	//    * $AccountName is the name of the account
	//
	//    * $AccountEmail is the globally unique email address of the account
	//
	//    * $AccountEmailNoDomain is the email address of the account without the
	//    domain name
	//
	// LabelTemplate is a required field
	LabelTemplate *string `min:"1" type:"string" required:"true"`

	// Use this structure to optionally create filters that specify that only some
	// metric namespaces or log groups are to be shared from the source account
	// to the monitoring account.
	LinkConfiguration *LinkConfiguration `type:"structure"`

	// An array of strings that define which types of data that the source account
	// shares with the monitoring account.
	//
	// ResourceTypes is a required field
	ResourceTypes []*string `min:"1" type:"list" required:"true" enum:"ResourceType"`

	// The ARN of the sink to use to create this link. You can use ListSinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html)
	// to find the ARNs of sinks.
	//
	// For more information about sinks, see CreateSink (https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html).
	//
	// SinkIdentifier is a required field
	SinkIdentifier *string `type:"string" required:"true"`

	// Assigns one or more tags (key-value pairs) to the link.
	//
	// Tags can help you organize and categorize your resources. You can also use
	// them to scope user permissions by granting a user permission to access or
	// change only resources with certain tag values.
	//
	// For more information about using tags to control access, see Controlling
	// access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateLinkInput) GoString 

func (s CreateLinkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLinkInput) SetLabelTemplate 

func (s *CreateLinkInput) SetLabelTemplate(v string) *CreateLinkInput

SetLabelTemplate sets the LabelTemplate field's value.

func (*CreateLinkInput) SetLinkConfiguration added in v1.51.30 

func (s *CreateLinkInput) SetLinkConfiguration(v *LinkConfiguration) *CreateLinkInput

SetLinkConfiguration sets the LinkConfiguration field's value.

func (*CreateLinkInput) SetResourceTypes 

func (s *CreateLinkInput) SetResourceTypes(v []*string) *CreateLinkInput

SetResourceTypes sets the ResourceTypes field's value.

func (*CreateLinkInput) SetSinkIdentifier 

func (s *CreateLinkInput) SetSinkIdentifier(v string) *CreateLinkInput

SetSinkIdentifier sets the SinkIdentifier field's value.

func (*CreateLinkInput) SetTags 

func (s *CreateLinkInput) SetTags(v map[string]*string) *CreateLinkInput

SetTags sets the Tags field's value.

func (CreateLinkInput) String 

func (s CreateLinkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLinkInput) Validate 

func (s *CreateLinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLinkOutput 

type CreateLinkOutput struct {

	// The ARN of the link that is newly created.
	Arn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the link
	// ARN.
	Id *string `type:"string"`

	// The label that you assigned to this link. If the labelTemplate includes variables,
	// this field displays the variables resolved to their actual values.
	Label *string `type:"string"`

	// The exact label template that you specified, with the variables not resolved.
	LabelTemplate *string `type:"string"`

	// This structure includes filters that specify which metric namespaces and
	// which log groups are shared from the source account to the monitoring account.
	LinkConfiguration *LinkConfiguration `type:"structure"`

	// The resource types supported by this link.
	ResourceTypes []*string `type:"list"`

	// The ARN of the sink that is used for this link.
	SinkArn *string `type:"string"`

	// The tags assigned to the link.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateLinkOutput) GoString 

func (s CreateLinkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLinkOutput) SetArn 

func (s *CreateLinkOutput) SetArn(v string) *CreateLinkOutput

SetArn sets the Arn field's value.

func (*CreateLinkOutput) SetId 

func (s *CreateLinkOutput) SetId(v string) *CreateLinkOutput

SetId sets the Id field's value.

func (*CreateLinkOutput) SetLabel 

func (s *CreateLinkOutput) SetLabel(v string) *CreateLinkOutput

SetLabel sets the Label field's value.

func (*CreateLinkOutput) SetLabelTemplate 

func (s *CreateLinkOutput) SetLabelTemplate(v string) *CreateLinkOutput

SetLabelTemplate sets the LabelTemplate field's value.

func (*CreateLinkOutput) SetLinkConfiguration added in v1.51.30 

func (s *CreateLinkOutput) SetLinkConfiguration(v *LinkConfiguration) *CreateLinkOutput

SetLinkConfiguration sets the LinkConfiguration field's value.

func (*CreateLinkOutput) SetResourceTypes 

func (s *CreateLinkOutput) SetResourceTypes(v []*string) *CreateLinkOutput

SetResourceTypes sets the ResourceTypes field's value.

func (*CreateLinkOutput) SetSinkArn 

func (s *CreateLinkOutput) SetSinkArn(v string) *CreateLinkOutput

SetSinkArn sets the SinkArn field's value.

func (*CreateLinkOutput) SetTags 

func (s *CreateLinkOutput) SetTags(v map[string]*string) *CreateLinkOutput

SetTags sets the Tags field's value.

func (CreateLinkOutput) String 

func (s CreateLinkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSinkInput 

type CreateSinkInput struct {

	// A name for the sink.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Assigns one or more tags (key-value pairs) to the link.
	//
	// Tags can help you organize and categorize your resources. You can also use
	// them to scope user permissions by granting a user permission to access or
	// change only resources with certain tag values.
	//
	// For more information about using tags to control access, see Controlling
	// access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateSinkInput) GoString 

func (s CreateSinkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSinkInput) SetName 

func (s *CreateSinkInput) SetName(v string) *CreateSinkInput

SetName sets the Name field's value.

func (*CreateSinkInput) SetTags 

func (s *CreateSinkInput) SetTags(v map[string]*string) *CreateSinkInput

SetTags sets the Tags field's value.

func (CreateSinkInput) String 

func (s CreateSinkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSinkInput) Validate 

func (s *CreateSinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSinkOutput 

type CreateSinkOutput struct {

	// The ARN of the sink that is newly created.
	Arn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the sink
	// ARN.
	Id *string `type:"string"`

	// The name of the sink.
	Name *string `type:"string"`

	// The tags assigned to the sink.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateSinkOutput) GoString 

func (s CreateSinkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSinkOutput) SetArn 

func (s *CreateSinkOutput) SetArn(v string) *CreateSinkOutput

SetArn sets the Arn field's value.

func (*CreateSinkOutput) SetId 

func (s *CreateSinkOutput) SetId(v string) *CreateSinkOutput

SetId sets the Id field's value.

func (*CreateSinkOutput) SetName 

func (s *CreateSinkOutput) SetName(v string) *CreateSinkOutput

SetName sets the Name field's value.

func (*CreateSinkOutput) SetTags 

func (s *CreateSinkOutput) SetTags(v map[string]*string) *CreateSinkOutput

SetTags sets the Tags field's value.

func (CreateSinkOutput) String 

func (s CreateSinkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLinkInput 

type DeleteLinkInput struct {

	// The ARN of the link to delete.
	//
	// Identifier is a required field
	Identifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLinkInput) GoString 

func (s DeleteLinkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLinkInput) SetIdentifier 

func (s *DeleteLinkInput) SetIdentifier(v string) *DeleteLinkInput

SetIdentifier sets the Identifier field's value.

func (DeleteLinkInput) String 

func (s DeleteLinkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLinkInput) Validate 

func (s *DeleteLinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLinkOutput 

type DeleteLinkOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLinkOutput) GoString 

func (s DeleteLinkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLinkOutput) String 

func (s DeleteLinkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSinkInput 

type DeleteSinkInput struct {

	// The ARN of the sink to delete.
	//
	// Identifier is a required field
	Identifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSinkInput) GoString 

func (s DeleteSinkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSinkInput) SetIdentifier 

func (s *DeleteSinkInput) SetIdentifier(v string) *DeleteSinkInput

SetIdentifier sets the Identifier field's value.

func (DeleteSinkInput) String 

func (s DeleteSinkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSinkInput) Validate 

func (s *DeleteSinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSinkOutput 

type DeleteSinkOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSinkOutput) GoString 

func (s DeleteSinkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSinkOutput) String 

func (s DeleteSinkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLinkInput 

type GetLinkInput struct {

	// The ARN of the link to retrieve information for.
	//
	// Identifier is a required field
	Identifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLinkInput) GoString 

func (s GetLinkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLinkInput) SetIdentifier 

func (s *GetLinkInput) SetIdentifier(v string) *GetLinkInput

SetIdentifier sets the Identifier field's value.

func (GetLinkInput) String 

func (s GetLinkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLinkInput) Validate 

func (s *GetLinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLinkOutput 

type GetLinkOutput struct {

	// The ARN of the link.
	Arn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the link
	// ARN.
	Id *string `type:"string"`

	// The label that you assigned to this link, with the variables resolved to
	// their actual values.
	Label *string `type:"string"`

	// The exact label template that was specified when the link was created, with
	// the template variables not resolved.
	LabelTemplate *string `type:"string"`

	// This structure includes filters that specify which metric namespaces and
	// which log groups are shared from the source account to the monitoring account.
	LinkConfiguration *LinkConfiguration `type:"structure"`

	// The resource types supported by this link.
	ResourceTypes []*string `type:"list"`

	// The ARN of the sink that is used for this link.
	SinkArn *string `type:"string"`

	// The tags assigned to the link.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (GetLinkOutput) GoString 

func (s GetLinkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLinkOutput) SetArn 

func (s *GetLinkOutput) SetArn(v string) *GetLinkOutput

SetArn sets the Arn field's value.

func (*GetLinkOutput) SetId 

func (s *GetLinkOutput) SetId(v string) *GetLinkOutput

SetId sets the Id field's value.

func (*GetLinkOutput) SetLabel 

func (s *GetLinkOutput) SetLabel(v string) *GetLinkOutput

SetLabel sets the Label field's value.

func (*GetLinkOutput) SetLabelTemplate 

func (s *GetLinkOutput) SetLabelTemplate(v string) *GetLinkOutput

SetLabelTemplate sets the LabelTemplate field's value.

func (*GetLinkOutput) SetLinkConfiguration added in v1.51.30 

func (s *GetLinkOutput) SetLinkConfiguration(v *LinkConfiguration) *GetLinkOutput

SetLinkConfiguration sets the LinkConfiguration field's value.

func (*GetLinkOutput) SetResourceTypes 

func (s *GetLinkOutput) SetResourceTypes(v []*string) *GetLinkOutput

SetResourceTypes sets the ResourceTypes field's value.

func (*GetLinkOutput) SetSinkArn 

func (s *GetLinkOutput) SetSinkArn(v string) *GetLinkOutput

SetSinkArn sets the SinkArn field's value.

func (*GetLinkOutput) SetTags 

func (s *GetLinkOutput) SetTags(v map[string]*string) *GetLinkOutput

SetTags sets the Tags field's value.

func (GetLinkOutput) String 

func (s GetLinkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSinkInput 

type GetSinkInput struct {

	// The ARN of the sink to retrieve information for.
	//
	// Identifier is a required field
	Identifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSinkInput) GoString 

func (s GetSinkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSinkInput) SetIdentifier 

func (s *GetSinkInput) SetIdentifier(v string) *GetSinkInput

SetIdentifier sets the Identifier field's value.

func (GetSinkInput) String 

func (s GetSinkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSinkInput) Validate 

func (s *GetSinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSinkOutput 

type GetSinkOutput struct {

	// The ARN of the sink.
	Arn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the sink
	// ARN.
	Id *string `type:"string"`

	// The name of the sink.
	Name *string `type:"string"`

	// The tags assigned to the sink.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (GetSinkOutput) GoString 

func (s GetSinkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSinkOutput) SetArn 

func (s *GetSinkOutput) SetArn(v string) *GetSinkOutput

SetArn sets the Arn field's value.

func (*GetSinkOutput) SetId 

func (s *GetSinkOutput) SetId(v string) *GetSinkOutput

SetId sets the Id field's value.

func (*GetSinkOutput) SetName 

func (s *GetSinkOutput) SetName(v string) *GetSinkOutput

SetName sets the Name field's value.

func (*GetSinkOutput) SetTags 

func (s *GetSinkOutput) SetTags(v map[string]*string) *GetSinkOutput

SetTags sets the Tags field's value.

func (GetSinkOutput) String 

func (s GetSinkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSinkPolicyInput 

type GetSinkPolicyInput struct {

	// The ARN of the sink to retrieve the policy of.
	//
	// SinkIdentifier is a required field
	SinkIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSinkPolicyInput) GoString 

func (s GetSinkPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSinkPolicyInput) SetSinkIdentifier 

func (s *GetSinkPolicyInput) SetSinkIdentifier(v string) *GetSinkPolicyInput

SetSinkIdentifier sets the SinkIdentifier field's value.

func (GetSinkPolicyInput) String 

func (s GetSinkPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSinkPolicyInput) Validate 

func (s *GetSinkPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSinkPolicyOutput 

type GetSinkPolicyOutput struct {

	// The policy that you specified, in JSON format.
	Policy *string `type:"string"`

	// The ARN of the sink.
	SinkArn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the sink
	// ARN.
	SinkId *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetSinkPolicyOutput) GoString 

func (s GetSinkPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSinkPolicyOutput) SetPolicy 

func (s *GetSinkPolicyOutput) SetPolicy(v string) *GetSinkPolicyOutput

SetPolicy sets the Policy field's value.

func (*GetSinkPolicyOutput) SetSinkArn 

func (s *GetSinkPolicyOutput) SetSinkArn(v string) *GetSinkPolicyOutput

SetSinkArn sets the SinkArn field's value.

func (*GetSinkPolicyOutput) SetSinkId 

func (s *GetSinkPolicyOutput) SetSinkId(v string) *GetSinkPolicyOutput

SetSinkId sets the SinkId field's value.

func (GetSinkPolicyOutput) String 

func (s GetSinkPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServiceFault 

type InternalServiceFault struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The name of the exception.
	AmznErrorType *string `location:"header" locationName:"x-amzn-ErrorType" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Unexpected error while processing the request. Retry the request.

func (*InternalServiceFault) Code 

func (s *InternalServiceFault) Code() string

Code returns the exception type name.

func (*InternalServiceFault) Error 

func (s *InternalServiceFault) Error() string

func (InternalServiceFault) GoString 

func (s InternalServiceFault) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServiceFault) Message 

func (s *InternalServiceFault) Message() string

Message returns the exception's message.

func (*InternalServiceFault) OrigErr 

func (s *InternalServiceFault) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceFault) RequestID 

func (s *InternalServiceFault) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceFault) StatusCode 

func (s *InternalServiceFault) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceFault) String 

func (s InternalServiceFault) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException 

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The name of the exception.
	AmznErrorType *string `location:"header" locationName:"x-amzn-ErrorType" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A parameter is specified incorrectly.

func (*InvalidParameterException) Code 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString 

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode 

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String 

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LinkConfiguration added in v1.51.30 

type LinkConfiguration struct {

	// Use this structure to filter which log groups are to send log events from
	// the source account to the monitoring account.
	LogGroupConfiguration *LogGroupConfiguration `type:"structure"`

	// Use this structure to filter which metric namespaces are to be shared from
	// the source account to the monitoring account.
	MetricConfiguration *MetricConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.

func (LinkConfiguration) GoString added in v1.51.30 

func (s LinkConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LinkConfiguration) SetLogGroupConfiguration added in v1.51.30 

func (s *LinkConfiguration) SetLogGroupConfiguration(v *LogGroupConfiguration) *LinkConfiguration

SetLogGroupConfiguration sets the LogGroupConfiguration field's value.

func (*LinkConfiguration) SetMetricConfiguration added in v1.51.30 

func (s *LinkConfiguration) SetMetricConfiguration(v *MetricConfiguration) *LinkConfiguration

SetMetricConfiguration sets the MetricConfiguration field's value.

func (LinkConfiguration) String added in v1.51.30 

func (s LinkConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LinkConfiguration) Validate added in v1.51.30 

func (s *LinkConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAttachedLinksInput 

type ListAttachedLinksInput struct {

	// Limits the number of returned links to the specified number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. You received this token from
	// a previous call.
	NextToken *string `type:"string"`

	// The ARN of the sink that you want to retrieve links for.
	//
	// SinkIdentifier is a required field
	SinkIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListAttachedLinksInput) GoString 

func (s ListAttachedLinksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAttachedLinksInput) SetMaxResults 

func (s *ListAttachedLinksInput) SetMaxResults(v int64) *ListAttachedLinksInput

SetMaxResults sets the MaxResults field's value.

func (*ListAttachedLinksInput) SetNextToken 

func (s *ListAttachedLinksInput) SetNextToken(v string) *ListAttachedLinksInput

SetNextToken sets the NextToken field's value.

func (*ListAttachedLinksInput) SetSinkIdentifier 

func (s *ListAttachedLinksInput) SetSinkIdentifier(v string) *ListAttachedLinksInput

SetSinkIdentifier sets the SinkIdentifier field's value.

func (ListAttachedLinksInput) String 

func (s ListAttachedLinksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAttachedLinksInput) Validate 

func (s *ListAttachedLinksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAttachedLinksItem 

type ListAttachedLinksItem struct {

	// The label that was assigned to this link at creation, with the variables
	// resolved to their actual values.
	Label *string `type:"string"`

	// The ARN of the link.
	LinkArn *string `type:"string"`

	// The resource types supported by this link.
	ResourceTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

A structure that contains information about one link attached to this monitoring account sink.

func (ListAttachedLinksItem) GoString 

func (s ListAttachedLinksItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAttachedLinksItem) SetLabel 

func (s *ListAttachedLinksItem) SetLabel(v string) *ListAttachedLinksItem

SetLabel sets the Label field's value.

func (*ListAttachedLinksItem) SetLinkArn 

func (s *ListAttachedLinksItem) SetLinkArn(v string) *ListAttachedLinksItem

SetLinkArn sets the LinkArn field's value.

func (*ListAttachedLinksItem) SetResourceTypes 

func (s *ListAttachedLinksItem) SetResourceTypes(v []*string) *ListAttachedLinksItem

SetResourceTypes sets the ResourceTypes field's value.

func (ListAttachedLinksItem) String 

func (s ListAttachedLinksItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAttachedLinksOutput 

type ListAttachedLinksOutput struct {

	// An array of structures that contain the information about the attached links.
	//
	// Items is a required field
	Items []*ListAttachedLinksItem `type:"list" required:"true"`

	// The token to use when requesting the next set of links.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAttachedLinksOutput) GoString 

func (s ListAttachedLinksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAttachedLinksOutput) SetItems 

func (s *ListAttachedLinksOutput) SetItems(v []*ListAttachedLinksItem) *ListAttachedLinksOutput

SetItems sets the Items field's value.

func (*ListAttachedLinksOutput) SetNextToken 

func (s *ListAttachedLinksOutput) SetNextToken(v string) *ListAttachedLinksOutput

SetNextToken sets the NextToken field's value.

func (ListAttachedLinksOutput) String 

func (s ListAttachedLinksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLinksInput 

type ListLinksInput struct {

	// Limits the number of returned links to the specified number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. You received this token from
	// a previous call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListLinksInput) GoString 

func (s ListLinksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinksInput) SetMaxResults 

func (s *ListLinksInput) SetMaxResults(v int64) *ListLinksInput

SetMaxResults sets the MaxResults field's value.

func (*ListLinksInput) SetNextToken 

func (s *ListLinksInput) SetNextToken(v string) *ListLinksInput

SetNextToken sets the NextToken field's value.

func (ListLinksInput) String 

func (s ListLinksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinksInput) Validate 

func (s *ListLinksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLinksItem 

type ListLinksItem struct {

	// The ARN of the link.
	Arn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the link
	// ARN.
	Id *string `type:"string"`

	// The label that was assigned to this link at creation, with the variables
	// resolved to their actual values.
	Label *string `type:"string"`

	// The resource types supported by this link.
	ResourceTypes []*string `type:"list"`

	// The ARN of the sink that this link is attached to.
	SinkArn *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that contains information about one of this source account's links to a monitoring account.

func (ListLinksItem) GoString 

func (s ListLinksItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinksItem) SetArn 

func (s *ListLinksItem) SetArn(v string) *ListLinksItem

SetArn sets the Arn field's value.

func (*ListLinksItem) SetId 

func (s *ListLinksItem) SetId(v string) *ListLinksItem

SetId sets the Id field's value.

func (*ListLinksItem) SetLabel 

func (s *ListLinksItem) SetLabel(v string) *ListLinksItem

SetLabel sets the Label field's value.

func (*ListLinksItem) SetResourceTypes 

func (s *ListLinksItem) SetResourceTypes(v []*string) *ListLinksItem

SetResourceTypes sets the ResourceTypes field's value.

func (*ListLinksItem) SetSinkArn 

func (s *ListLinksItem) SetSinkArn(v string) *ListLinksItem

SetSinkArn sets the SinkArn field's value.

func (ListLinksItem) String 

func (s ListLinksItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLinksOutput 

type ListLinksOutput struct {

	// An array of structures that contain the information about the returned links.
	//
	// Items is a required field
	Items []*ListLinksItem `type:"list" required:"true"`

	// The token to use when requesting the next set of links.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListLinksOutput) GoString 

func (s ListLinksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLinksOutput) SetItems 

func (s *ListLinksOutput) SetItems(v []*ListLinksItem) *ListLinksOutput

SetItems sets the Items field's value.

func (*ListLinksOutput) SetNextToken 

func (s *ListLinksOutput) SetNextToken(v string) *ListLinksOutput

SetNextToken sets the NextToken field's value.

func (ListLinksOutput) String 

func (s ListLinksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSinksInput 

type ListSinksInput struct {

	// Limits the number of returned links to the specified number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. You received this token from
	// a previous call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSinksInput) GoString 

func (s ListSinksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSinksInput) SetMaxResults 

func (s *ListSinksInput) SetMaxResults(v int64) *ListSinksInput

SetMaxResults sets the MaxResults field's value.

func (*ListSinksInput) SetNextToken 

func (s *ListSinksInput) SetNextToken(v string) *ListSinksInput

SetNextToken sets the NextToken field's value.

func (ListSinksInput) String 

func (s ListSinksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSinksInput) Validate 

func (s *ListSinksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSinksItem 

type ListSinksItem struct {

	// The ARN of the sink.
	Arn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the sink
	// ARN.
	Id *string `type:"string"`

	// The name of the sink.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that contains information about one of this monitoring account's sinks.

func (ListSinksItem) GoString 

func (s ListSinksItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSinksItem) SetArn 

func (s *ListSinksItem) SetArn(v string) *ListSinksItem

SetArn sets the Arn field's value.

func (*ListSinksItem) SetId 

func (s *ListSinksItem) SetId(v string) *ListSinksItem

SetId sets the Id field's value.

func (*ListSinksItem) SetName 

func (s *ListSinksItem) SetName(v string) *ListSinksItem

SetName sets the Name field's value.

func (ListSinksItem) String 

func (s ListSinksItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSinksOutput 

type ListSinksOutput struct {

	// An array of structures that contain the information about the returned sinks.
	//
	// Items is a required field
	Items []*ListSinksItem `type:"list" required:"true"`

	// The token to use when requesting the next set of sinks.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSinksOutput) GoString 

func (s ListSinksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSinksOutput) SetItems 

func (s *ListSinksOutput) SetItems(v []*ListSinksItem) *ListSinksOutput

SetItems sets the Items field's value.

func (*ListSinksOutput) SetNextToken 

func (s *ListSinksOutput) SetNextToken(v string) *ListSinksOutput

SetNextToken sets the NextToken field's value.

func (ListSinksOutput) String 

func (s ListSinksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource that you want to view tags for.
	//
	// The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
	//
	// The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
	//
	// For more information about ARN format, see CloudWatch Logs resources and
	// operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html).
	//
	// Unlike tagging permissions in other Amazon Web Services services, to retrieve
	// the list of tags for links or sinks you must have the oam:RequestTag permission.
	// The aws:ReguestTag permission does not allow you to tag and untag links and
	// sinks.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tags associated with the requested resource.>
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogGroupConfiguration added in v1.51.30 

type LogGroupConfiguration struct {

	// Use this field to specify which log groups are to share their log events
	// with the monitoring account. Use the term LogGroupName and one or more of
	// the following operands. Use single quotation marks (') around log group names.
	// The matching of log group names is case sensitive. Each filter has a limit
	// of five conditional operands. Conditional operands are AND and OR.
	//
	//    * = and !=
	//
	//    * AND
	//
	//    * OR
	//
	//    * LIKE and NOT LIKE. These can be used only as prefix searches. Include
	//    a % at the end of the string that you want to search for and include.
	//
	//    * IN and NOT IN, using parentheses ( )
	//
	// Examples:
	//
	//    * LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only
	//    the log groups with names This-Log-Group and Other-Log-Group.
	//
	//    * LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes
	//    all log groups except the log groups with names Private-Log-Group and
	//    Private-Log-Group-2.
	//
	//    * LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes
	//    all log groups that have names that start with aws/lambda/ or AWSLogs.
	//
	// If you are updating a link that uses filters, you can specify * as the only
	// value for the filter parameter to delete the filter and share all log groups
	// with the monitoring account.
	//
	// Filter is a required field
	Filter *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This structure contains the Filter parameter which you can use to specify which log groups are to share log events from this source account to the monitoring account.

func (LogGroupConfiguration) GoString added in v1.51.30 

func (s LogGroupConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogGroupConfiguration) SetFilter added in v1.51.30 

func (s *LogGroupConfiguration) SetFilter(v string) *LogGroupConfiguration

SetFilter sets the Filter field's value.

func (LogGroupConfiguration) String added in v1.51.30 

func (s LogGroupConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogGroupConfiguration) Validate added in v1.51.30 

func (s *LogGroupConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MetricConfiguration added in v1.51.30 

type MetricConfiguration struct {

	// Use this field to specify which metrics are to be shared with the monitoring
	// account. Use the term Namespace and one or more of the following operands.
	// Use single quotation marks (') around namespace names. The matching of namespace
	// names is case sensitive. Each filter has a limit of five conditional operands.
	// Conditional operands are AND and OR.
	//
	//    * = and !=
	//
	//    * AND
	//
	//    * OR
	//
	//    * LIKE and NOT LIKE. These can be used only as prefix searches. Include
	//    a % at the end of the string that you want to search for and include.
	//
	//    * IN and NOT IN, using parentheses ( )
	//
	// Examples:
	//
	//    * Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start
	//    with AWS/, such as custom namespaces.
	//
	//    * Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics
	//    in the EC2, Elastic Load Balancing, and Amazon S3 namespaces.
	//
	//    * Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the
	//    EC2 namespace and your custom namespaces.
	//
	// If you are updating a link that uses filters, you can specify * as the only
	// value for the filter parameter to delete the filter and share all metric
	// namespaces with the monitoring account.
	//
	// Filter is a required field
	Filter *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This structure contains the Filter parameter which you can use to specify which metric namespaces are to be shared from this source account to the monitoring account.

func (MetricConfiguration) GoString added in v1.51.30 

func (s MetricConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricConfiguration) SetFilter added in v1.51.30 

func (s *MetricConfiguration) SetFilter(v string) *MetricConfiguration

SetFilter sets the Filter field's value.

func (MetricConfiguration) String added in v1.51.30 

func (s MetricConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricConfiguration) Validate added in v1.51.30 

func (s *MetricConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MissingRequiredParameterException 

type MissingRequiredParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The name of the exception.
	AmznErrorType *string `location:"header" locationName:"x-amzn-ErrorType" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A required parameter is missing from the request.

func (*MissingRequiredParameterException) Code 

func (s *MissingRequiredParameterException) Code() string

Code returns the exception type name.

func (*MissingRequiredParameterException) Error 

func (s *MissingRequiredParameterException) Error() string

func (MissingRequiredParameterException) GoString 

func (s MissingRequiredParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MissingRequiredParameterException) Message 

func (s *MissingRequiredParameterException) Message() string

Message returns the exception's message.

func (*MissingRequiredParameterException) OrigErr 

func (s *MissingRequiredParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingRequiredParameterException) RequestID 

func (s *MissingRequiredParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingRequiredParameterException) StatusCode 

func (s *MissingRequiredParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MissingRequiredParameterException) String 

func (s MissingRequiredParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OAM 

type OAM struct {
	*client.Client
}

OAM provides the API operation methods for making requests to CloudWatch Observability Access Manager. See this package's package overview docs for details on the service.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *OAM

New creates a new instance of the OAM client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a OAM client from just a session.
svc := oam.New(mySession)

// Create a OAM client with additional configuration
svc := oam.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (c *OAM) CreateLink(input *CreateLinkInput) (*CreateLinkOutput, error)

CreateLink API operation for CloudWatch Observability Access Manager.

Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.

For more information, see CreateSink (https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html) and PutSinkPolicy (https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html).

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

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 CloudWatch Observability Access Manager's API operation CreateLink for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • InvalidParameterException A parameter is specified incorrectly.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/CreateLink

func (*OAM) CreateLinkRequest 

func (c *OAM) CreateLinkRequest(input *CreateLinkInput) (req *request.Request, output *CreateLinkOutput)

CreateLinkRequest generates a "aws/request.Request" representing the client's request for the CreateLink 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 CreateLink for more information on using the CreateLink 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 CreateLinkRequest method.
req, resp := client.CreateLinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/CreateLink

func (*OAM) CreateLinkWithContext 

func (c *OAM) CreateLinkWithContext(ctx aws.Context, input *CreateLinkInput, opts ...request.Option) (*CreateLinkOutput, error)

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

See CreateLink 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.

func (*OAM) CreateSink 

func (c *OAM) CreateSink(input *CreateSinkInput) (*CreateSinkOutput, error)

CreateSink API operation for CloudWatch Observability Access Manager.

Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.

After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy (https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html).

Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that 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 CloudWatch Observability Access Manager's API operation CreateSink for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • InvalidParameterException A parameter is specified incorrectly.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/CreateSink

func (*OAM) CreateSinkRequest 

func (c *OAM) CreateSinkRequest(input *CreateSinkInput) (req *request.Request, output *CreateSinkOutput)

CreateSinkRequest generates a "aws/request.Request" representing the client's request for the CreateSink 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 CreateSink for more information on using the CreateSink 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 CreateSinkRequest method.
req, resp := client.CreateSinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/CreateSink

func (*OAM) CreateSinkWithContext 

func (c *OAM) CreateSinkWithContext(ctx aws.Context, input *CreateSinkInput, opts ...request.Option) (*CreateSinkOutput, error)

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

See CreateSink 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. 

func (c *OAM) DeleteLink(input *DeleteLinkInput) (*DeleteLinkOutput, error)

DeleteLink API operation for CloudWatch Observability Access Manager.

Deletes a link between a monitoring account sink and a source account. You must run this operation in the source 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 CloudWatch Observability Access Manager's API operation DeleteLink for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/DeleteLink

func (*OAM) DeleteLinkRequest 

func (c *OAM) DeleteLinkRequest(input *DeleteLinkInput) (req *request.Request, output *DeleteLinkOutput)

DeleteLinkRequest generates a "aws/request.Request" representing the client's request for the DeleteLink 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 DeleteLink for more information on using the DeleteLink 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 DeleteLinkRequest method.
req, resp := client.DeleteLinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/DeleteLink

func (*OAM) DeleteLinkWithContext 

func (c *OAM) DeleteLinkWithContext(ctx aws.Context, input *DeleteLinkInput, opts ...request.Option) (*DeleteLinkOutput, error)

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

See DeleteLink 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.

func (*OAM) DeleteSink 

func (c *OAM) DeleteSink(input *DeleteSinkInput) (*DeleteSinkOutput, error)

DeleteSink API operation for CloudWatch Observability Access Manager.

Deletes a sink. You must delete all links to a sink before you can delete that sink.

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 CloudWatch Observability Access Manager's API operation DeleteSink for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/DeleteSink

func (*OAM) DeleteSinkRequest 

func (c *OAM) DeleteSinkRequest(input *DeleteSinkInput) (req *request.Request, output *DeleteSinkOutput)

DeleteSinkRequest generates a "aws/request.Request" representing the client's request for the DeleteSink 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 DeleteSink for more information on using the DeleteSink 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 DeleteSinkRequest method.
req, resp := client.DeleteSinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/DeleteSink

func (*OAM) DeleteSinkWithContext 

func (c *OAM) DeleteSinkWithContext(ctx aws.Context, input *DeleteSinkInput, opts ...request.Option) (*DeleteSinkOutput, error)

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

See DeleteSink 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. 

func (c *OAM) GetLink(input *GetLinkInput) (*GetLinkOutput, error)

GetLink API operation for CloudWatch Observability Access Manager.

Returns complete information about one link.

To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.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 CloudWatch Observability Access Manager's API operation GetLink for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetLink

func (*OAM) GetLinkRequest 

func (c *OAM) GetLinkRequest(input *GetLinkInput) (req *request.Request, output *GetLinkOutput)

GetLinkRequest generates a "aws/request.Request" representing the client's request for the GetLink 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 GetLink for more information on using the GetLink 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 GetLinkRequest method.
req, resp := client.GetLinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetLink

func (*OAM) GetLinkWithContext 

func (c *OAM) GetLinkWithContext(ctx aws.Context, input *GetLinkInput, opts ...request.Option) (*GetLinkOutput, error)

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

See GetLink 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.

func (*OAM) GetSink 

func (c *OAM) GetSink(input *GetSinkInput) (*GetSinkOutput, error)

GetSink API operation for CloudWatch Observability Access Manager.

Returns complete information about one monitoring account sink.

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.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 CloudWatch Observability Access Manager's API operation GetSink for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSink

func (*OAM) GetSinkPolicy 

func (c *OAM) GetSinkPolicy(input *GetSinkPolicyInput) (*GetSinkPolicyOutput, error)

GetSinkPolicy API operation for CloudWatch Observability Access Manager.

Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.

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 CloudWatch Observability Access Manager's API operation GetSinkPolicy for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSinkPolicy

func (*OAM) GetSinkPolicyRequest 

func (c *OAM) GetSinkPolicyRequest(input *GetSinkPolicyInput) (req *request.Request, output *GetSinkPolicyOutput)

GetSinkPolicyRequest generates a "aws/request.Request" representing the client's request for the GetSinkPolicy 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 GetSinkPolicy for more information on using the GetSinkPolicy 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 GetSinkPolicyRequest method.
req, resp := client.GetSinkPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSinkPolicy

func (*OAM) GetSinkPolicyWithContext 

func (c *OAM) GetSinkPolicyWithContext(ctx aws.Context, input *GetSinkPolicyInput, opts ...request.Option) (*GetSinkPolicyOutput, error)

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

See GetSinkPolicy 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.

func (*OAM) GetSinkRequest 

func (c *OAM) GetSinkRequest(input *GetSinkInput) (req *request.Request, output *GetSinkOutput)

GetSinkRequest generates a "aws/request.Request" representing the client's request for the GetSink 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 GetSink for more information on using the GetSink 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 GetSinkRequest method.
req, resp := client.GetSinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSink

func (*OAM) GetSinkWithContext 

func (c *OAM) GetSinkWithContext(ctx aws.Context, input *GetSinkInput, opts ...request.Option) (*GetSinkOutput, error)

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

See GetSink 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. 

func (c *OAM) ListAttachedLinks(input *ListAttachedLinksInput) (*ListAttachedLinksOutput, error)

ListAttachedLinks API operation for CloudWatch Observability Access Manager.

Returns a list of source account links that are linked to this monitoring account sink.

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html).

To find a list of links for one source account, use ListLinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.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 CloudWatch Observability Access Manager's API operation ListAttachedLinks for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListAttachedLinks

func (*OAM) ListAttachedLinksPages 

func (c *OAM) ListAttachedLinksPages(input *ListAttachedLinksInput, fn func(*ListAttachedLinksOutput, bool) bool) error

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

See ListAttachedLinks 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 ListAttachedLinks operation.
pageNum := 0
err := client.ListAttachedLinksPages(params,
    func(page *oam.ListAttachedLinksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OAM) ListAttachedLinksPagesWithContext 

func (c *OAM) ListAttachedLinksPagesWithContext(ctx aws.Context, input *ListAttachedLinksInput, fn func(*ListAttachedLinksOutput, bool) bool, opts ...request.Option) error

ListAttachedLinksPagesWithContext same as ListAttachedLinksPages 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.

func (*OAM) ListAttachedLinksRequest 

func (c *OAM) ListAttachedLinksRequest(input *ListAttachedLinksInput) (req *request.Request, output *ListAttachedLinksOutput)

ListAttachedLinksRequest generates a "aws/request.Request" representing the client's request for the ListAttachedLinks 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 ListAttachedLinks for more information on using the ListAttachedLinks 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 ListAttachedLinksRequest method.
req, resp := client.ListAttachedLinksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListAttachedLinks

func (*OAM) ListAttachedLinksWithContext 

func (c *OAM) ListAttachedLinksWithContext(ctx aws.Context, input *ListAttachedLinksInput, opts ...request.Option) (*ListAttachedLinksOutput, error)

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

See ListAttachedLinks 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. 

func (c *OAM) ListLinks(input *ListLinksInput) (*ListLinksOutput, error)

ListLinks API operation for CloudWatch Observability Access Manager.

Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.

To find a list of links for one monitoring account sink, use ListAttachedLinks (https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListAttachedLinks.html) from within the monitoring 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 CloudWatch Observability Access Manager's API operation ListLinks for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListLinks

func (*OAM) ListLinksPages 

func (c *OAM) ListLinksPages(input *ListLinksInput, fn func(*ListLinksOutput, bool) bool) error

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

See ListLinks 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 ListLinks operation.
pageNum := 0
err := client.ListLinksPages(params,
    func(page *oam.ListLinksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OAM) ListLinksPagesWithContext 

func (c *OAM) ListLinksPagesWithContext(ctx aws.Context, input *ListLinksInput, fn func(*ListLinksOutput, bool) bool, opts ...request.Option) error

ListLinksPagesWithContext same as ListLinksPages 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.

func (*OAM) ListLinksRequest 

func (c *OAM) ListLinksRequest(input *ListLinksInput) (req *request.Request, output *ListLinksOutput)

ListLinksRequest generates a "aws/request.Request" representing the client's request for the ListLinks 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 ListLinks for more information on using the ListLinks 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 ListLinksRequest method.
req, resp := client.ListLinksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListLinks

func (*OAM) ListLinksWithContext 

func (c *OAM) ListLinksWithContext(ctx aws.Context, input *ListLinksInput, opts ...request.Option) (*ListLinksOutput, error)

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

See ListLinks 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.

func (*OAM) ListSinks 

func (c *OAM) ListSinks(input *ListSinksInput) (*ListSinksOutput, error)

ListSinks API operation for CloudWatch Observability Access Manager.

Use this operation in a monitoring account to return the list of sinks created in that 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 CloudWatch Observability Access Manager's API operation ListSinks for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListSinks

func (*OAM) ListSinksPages 

func (c *OAM) ListSinksPages(input *ListSinksInput, fn func(*ListSinksOutput, bool) bool) error

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

See ListSinks 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 ListSinks operation.
pageNum := 0
err := client.ListSinksPages(params,
    func(page *oam.ListSinksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*OAM) ListSinksPagesWithContext 

func (c *OAM) ListSinksPagesWithContext(ctx aws.Context, input *ListSinksInput, fn func(*ListSinksOutput, bool) bool, opts ...request.Option) error

ListSinksPagesWithContext same as ListSinksPages 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.

func (*OAM) ListSinksRequest 

func (c *OAM) ListSinksRequest(input *ListSinksInput) (req *request.Request, output *ListSinksOutput)

ListSinksRequest generates a "aws/request.Request" representing the client's request for the ListSinks 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 ListSinks for more information on using the ListSinks 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 ListSinksRequest method.
req, resp := client.ListSinksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListSinks

func (*OAM) ListSinksWithContext 

func (c *OAM) ListSinksWithContext(ctx aws.Context, input *ListSinksInput, opts ...request.Option) (*ListSinksOutput, error)

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

See ListSinks 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.

func (*OAM) ListTagsForResource 

func (c *OAM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for CloudWatch Observability Access Manager.

Displays the tags associated with a resource. Both sinks and links support tagging.

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 CloudWatch Observability Access Manager's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ValidationException The value of a parameter in the request caused an error.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListTagsForResource

func (*OAM) ListTagsForResourceRequest 

func (c *OAM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListTagsForResource

func (*OAM) ListTagsForResourceWithContext 

func (c *OAM) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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.

func (*OAM) PutSinkPolicy 

func (c *OAM) PutSinkPolicy(input *PutSinkPolicyInput) (*PutSinkPolicyOutput, error)

PutSinkPolicy API operation for CloudWatch Observability Access Manager.

Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.

You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:

  • Metrics - Specify with AWS::CloudWatch::Metric

  • Log groups - Specify with AWS::Logs::LogGroup

  • Traces - Specify with AWS::XRay::Trace

  • Application Insights - Applications - Specify with AWS::ApplicationInsights::Application

See the examples in this section to see how to specify permitted source accounts and data types.

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 CloudWatch Observability Access Manager's API operation PutSinkPolicy for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/PutSinkPolicy

func (*OAM) PutSinkPolicyRequest 

func (c *OAM) PutSinkPolicyRequest(input *PutSinkPolicyInput) (req *request.Request, output *PutSinkPolicyOutput)

PutSinkPolicyRequest generates a "aws/request.Request" representing the client's request for the PutSinkPolicy 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 PutSinkPolicy for more information on using the PutSinkPolicy 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 PutSinkPolicyRequest method.
req, resp := client.PutSinkPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/PutSinkPolicy

func (*OAM) PutSinkPolicyWithContext 

func (c *OAM) PutSinkPolicyWithContext(ctx aws.Context, input *PutSinkPolicyInput, opts ...request.Option) (*PutSinkPolicyOutput, error)

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

See PutSinkPolicy 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.

func (*OAM) TagResource 

func (c *OAM) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for CloudWatch Observability Access Manager.

Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.

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 CloudWatch Observability Access Manager's API operation TagResource for usage and error information.

Returned Error Types:

  • ValidationException The value of a parameter in the request caused an error.

  • TooManyTagsException A resource can have no more than 50 tags.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/TagResource

func (*OAM) TagResourceRequest 

func (c *OAM) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/TagResource

func (*OAM) TagResourceWithContext 

func (c *OAM) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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.

func (*OAM) UntagResource 

func (c *OAM) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for CloudWatch Observability Access Manager.

Removes one or more tags from the specified resource.

Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.

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 CloudWatch Observability Access Manager's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException The value of a parameter in the request caused an error.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/UntagResource

func (*OAM) UntagResourceRequest 

func (c *OAM) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/UntagResource

func (*OAM) UntagResourceWithContext 

func (c *OAM) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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. 

func (c *OAM) UpdateLink(input *UpdateLinkInput) (*UpdateLinkOutput, error)

UpdateLink API operation for CloudWatch Observability Access Manager.

Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.

When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

To update the list of tags associated with the sink, use TagResource (https://docs.aws.amazon.com/OAM/latest/APIReference/API_TagResource.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 CloudWatch Observability Access Manager's API operation UpdateLink for usage and error information.

Returned Error Types:

  • InternalServiceFault Unexpected error while processing the request. Retry the request.

  • MissingRequiredParameterException A required parameter is missing from the request.

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The request references a resource that does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/UpdateLink

func (*OAM) UpdateLinkRequest 

func (c *OAM) UpdateLinkRequest(input *UpdateLinkInput) (req *request.Request, output *UpdateLinkOutput)

UpdateLinkRequest generates a "aws/request.Request" representing the client's request for the UpdateLink 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 UpdateLink for more information on using the UpdateLink 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 UpdateLinkRequest method.
req, resp := client.UpdateLinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/UpdateLink

func (*OAM) UpdateLinkWithContext 

func (c *OAM) UpdateLinkWithContext(ctx aws.Context, input *UpdateLinkInput, opts ...request.Option) (*UpdateLinkOutput, error)

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

See UpdateLink 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.

type PutSinkPolicyInput 

type PutSinkPolicyInput struct {

	// The JSON policy to use. If you are updating an existing policy, the entire
	// existing policy is replaced by what you specify here.
	//
	// The policy must be in JSON string format with quotation marks escaped and
	// no newlines.
	//
	// For examples of different types of policies, see the Examples section on
	// this page.
	//
	// Policy is a required field
	Policy *string `type:"string" required:"true"`

	// The ARN of the sink to attach this policy to.
	//
	// SinkIdentifier is a required field
	SinkIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutSinkPolicyInput) GoString 

func (s PutSinkPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSinkPolicyInput) SetPolicy 

func (s *PutSinkPolicyInput) SetPolicy(v string) *PutSinkPolicyInput

SetPolicy sets the Policy field's value.

func (*PutSinkPolicyInput) SetSinkIdentifier 

func (s *PutSinkPolicyInput) SetSinkIdentifier(v string) *PutSinkPolicyInput

SetSinkIdentifier sets the SinkIdentifier field's value.

func (PutSinkPolicyInput) String 

func (s PutSinkPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSinkPolicyInput) Validate 

func (s *PutSinkPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutSinkPolicyOutput 

type PutSinkPolicyOutput struct {

	// The policy that you specified.
	Policy *string `type:"string"`

	// The ARN of the sink.
	SinkArn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the sink
	// ARN.
	SinkId *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutSinkPolicyOutput) GoString 

func (s PutSinkPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSinkPolicyOutput) SetPolicy 

func (s *PutSinkPolicyOutput) SetPolicy(v string) *PutSinkPolicyOutput

SetPolicy sets the Policy field's value.

func (*PutSinkPolicyOutput) SetSinkArn 

func (s *PutSinkPolicyOutput) SetSinkArn(v string) *PutSinkPolicyOutput

SetSinkArn sets the SinkArn field's value.

func (*PutSinkPolicyOutput) SetSinkId 

func (s *PutSinkPolicyOutput) SetSinkId(v string) *PutSinkPolicyOutput

SetSinkId sets the SinkId field's value.

func (PutSinkPolicyOutput) String 

func (s PutSinkPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The name of the exception.
	AmznErrorType *string `location:"header" locationName:"x-amzn-ErrorType" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request references a resource that does not exist.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The name of the exception.
	AmznErrorType *string `location:"header" locationName:"x-amzn-ErrorType" type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource that you're adding tags to.
	//
	// The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
	//
	// The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
	//
	// For more information about ARN format, see CloudWatch Logs resources and
	// operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html).
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// The list of key-value pairs to associate with the resource.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyTagsException 

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

A resource can have no more than 50 tags.

func (*TooManyTagsException) Code 

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error 

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString 

func (s TooManyTagsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyTagsException) Message 

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr 

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID 

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode 

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String 

func (s TooManyTagsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource that you're removing tags from.
	//
	// The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id
	//
	// The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id
	//
	// For more information about ARN format, see CloudWatch Logs resources and
	// operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html).
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// The list of tag keys to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLinkInput 

type UpdateLinkInput struct {

	// The ARN of the link that you want to update.
	//
	// Identifier is a required field
	Identifier *string `type:"string" required:"true"`

	// Use this structure to filter which metric namespaces and which log groups
	// are to be shared from the source account to the monitoring account.
	LinkConfiguration *LinkConfiguration `type:"structure"`

	// An array of strings that define which types of data that the source account
	// will send to the monitoring account.
	//
	// Your input here replaces the current set of data types that are shared.
	//
	// ResourceTypes is a required field
	ResourceTypes []*string `min:"1" type:"list" required:"true" enum:"ResourceType"`
	// contains filtered or unexported fields
}

func (UpdateLinkInput) GoString 

func (s UpdateLinkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLinkInput) SetIdentifier 

func (s *UpdateLinkInput) SetIdentifier(v string) *UpdateLinkInput

SetIdentifier sets the Identifier field's value.

func (*UpdateLinkInput) SetLinkConfiguration added in v1.51.30 

func (s *UpdateLinkInput) SetLinkConfiguration(v *LinkConfiguration) *UpdateLinkInput

SetLinkConfiguration sets the LinkConfiguration field's value.

func (*UpdateLinkInput) SetResourceTypes 

func (s *UpdateLinkInput) SetResourceTypes(v []*string) *UpdateLinkInput

SetResourceTypes sets the ResourceTypes field's value.

func (UpdateLinkInput) String 

func (s UpdateLinkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLinkInput) Validate 

func (s *UpdateLinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLinkOutput 

type UpdateLinkOutput struct {

	// The ARN of the link that you have updated.
	Arn *string `type:"string"`

	// The random ID string that Amazon Web Services generated as part of the sink
	// ARN.
	Id *string `type:"string"`

	// The label assigned to this link, with the variables resolved to their actual
	// values.
	Label *string `type:"string"`

	// The exact label template that was specified when the link was created, with
	// the template variables not resolved.
	LabelTemplate *string `min:"1" type:"string"`

	// This structure includes filters that specify which metric namespaces and
	// which log groups are shared from the source account to the monitoring account.
	LinkConfiguration *LinkConfiguration `type:"structure"`

	// The resource types now supported by this link.
	ResourceTypes []*string `type:"list"`

	// The ARN of the sink that is used for this link.
	SinkArn *string `type:"string"`

	// The tags assigned to the link.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (UpdateLinkOutput) GoString 

func (s UpdateLinkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLinkOutput) SetArn 

func (s *UpdateLinkOutput) SetArn(v string) *UpdateLinkOutput

SetArn sets the Arn field's value.

func (*UpdateLinkOutput) SetId 

func (s *UpdateLinkOutput) SetId(v string) *UpdateLinkOutput

SetId sets the Id field's value.

func (*UpdateLinkOutput) SetLabel 

func (s *UpdateLinkOutput) SetLabel(v string) *UpdateLinkOutput

SetLabel sets the Label field's value.

func (*UpdateLinkOutput) SetLabelTemplate 

func (s *UpdateLinkOutput) SetLabelTemplate(v string) *UpdateLinkOutput

SetLabelTemplate sets the LabelTemplate field's value.

func (*UpdateLinkOutput) SetLinkConfiguration added in v1.51.30 

func (s *UpdateLinkOutput) SetLinkConfiguration(v *LinkConfiguration) *UpdateLinkOutput

SetLinkConfiguration sets the LinkConfiguration field's value.

func (*UpdateLinkOutput) SetResourceTypes 

func (s *UpdateLinkOutput) SetResourceTypes(v []*string) *UpdateLinkOutput

SetResourceTypes sets the ResourceTypes field's value.

func (*UpdateLinkOutput) SetSinkArn 

func (s *UpdateLinkOutput) SetSinkArn(v string) *UpdateLinkOutput

SetSinkArn sets the SinkArn field's value.

func (*UpdateLinkOutput) SetTags 

func (s *UpdateLinkOutput) SetTags(v map[string]*string) *UpdateLinkOutput

SetTags sets the Tags field's value.

func (UpdateLinkOutput) String 

func (s UpdateLinkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The value of a parameter in the request caused an error.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package oamiface provides an interface to enable mocking the CloudWatch Observability Access Manager service client for testing your code.
 Package oamiface provides an interface to enable mocking the CloudWatch Observability Access Manager service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.