observabilityadmin

package module
v1.0.10 Latest Latest
Warning

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

 Go to latest Published: Feb 18, 2025 License: Apache-2.0 Imports: 43 Imported by: 2

Documentation

Overview

Package observabilityadmin provides the API client, operations, and parameter types for CloudWatch Observability Admin Service. 

Amazon CloudWatch Obsersavability Admin to control temletry config for your

AWS Organization or account. Telemetry config config to discover and understand the state of telemetry configuration for your AWS resources from a central view in the CloudWatch console. Telemetry config simplifies the process of auditing your telemetry collection configurations across multiple resource types across your AWS Organization or account. For more information, see Auditing CloudWatch telemetry configurationsin the CloudWatch User Guide.

For information on the permissions you need to use this API, see Identity and access management for Amazon CloudWatch in the CloudWatch User Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-10"
View Source 
const ServiceID = "ObservabilityAdmin"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for CloudWatch Observability Admin Service.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) GetTelemetryEvaluationStatus 

func (c *Client) GetTelemetryEvaluationStatus(ctx context.Context, params *GetTelemetryEvaluationStatusInput, optFns ...func(*Options)) (*GetTelemetryEvaluationStatusOutput, error)
Returns the current onboarding status of the telemetry config feature,

including the status of the feature and reason the feature failed to start or stop.

func (*Client) GetTelemetryEvaluationStatusForOrganization 

func (c *Client) GetTelemetryEvaluationStatusForOrganization(ctx context.Context, params *GetTelemetryEvaluationStatusForOrganizationInput, optFns ...func(*Options)) (*GetTelemetryEvaluationStatusForOrganizationOutput, error)
This returns the onboarding status of the telemetry configuration feature for

the organization. It can only be called by a Management Account of an AWS Organization or an assigned Delegated Admin Account of AWS CloudWatch telemetry config.

func (*Client) ListResourceTelemetry 

func (c *Client) ListResourceTelemetry(ctx context.Context, params *ListResourceTelemetryInput, optFns ...func(*Options)) (*ListResourceTelemetryOutput, error)
Returns a list of telemetry configurations for AWS resources supported by

telemetry config. For more information, see Auditing CloudWatch telemetry configurations.

func (*Client) ListResourceTelemetryForOrganization 

func (c *Client) ListResourceTelemetryForOrganization(ctx context.Context, params *ListResourceTelemetryForOrganizationInput, optFns ...func(*Options)) (*ListResourceTelemetryForOrganizationOutput, error)
Returns a list of telemetry configurations for AWS resources supported by

telemetry config in the organization.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) StartTelemetryEvaluation 

func (c *Client) StartTelemetryEvaluation(ctx context.Context, params *StartTelemetryEvaluationInput, optFns ...func(*Options)) (*StartTelemetryEvaluationOutput, error)
This action begins onboarding onboarding the caller AWS account to the

telemetry config feature.

func (*Client) StartTelemetryEvaluationForOrganization 

func (c *Client) StartTelemetryEvaluationForOrganization(ctx context.Context, params *StartTelemetryEvaluationForOrganizationInput, optFns ...func(*Options)) (*StartTelemetryEvaluationForOrganizationOutput, error)
This actions begins onboarding the organization and all member accounts to the

telemetry config feature.

func (*Client) StopTelemetryEvaluation 

func (c *Client) StopTelemetryEvaluation(ctx context.Context, params *StopTelemetryEvaluationInput, optFns ...func(*Options)) (*StopTelemetryEvaluationOutput, error)
This action begins offboarding the caller AWS account from the telemetry

config feature.

func (*Client) StopTelemetryEvaluationForOrganization 

func (c *Client) StopTelemetryEvaluationForOrganization(ctx context.Context, params *StopTelemetryEvaluationForOrganizationInput, optFns ...func(*Options)) (*StopTelemetryEvaluationForOrganizationOutput, error)
This action offboards the Organization of the caller AWS account from thef

telemetry config feature.

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetTelemetryEvaluationStatusForOrganizationInput 

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

type GetTelemetryEvaluationStatusForOrganizationOutput 

type GetTelemetryEvaluationStatusForOrganizationOutput struct {

	//  This field describes the reason for the failure status. The field will only be
	// populated if Status is FAILED_START or FAILED_STOP .
	FailureReason *string

	//  The onboarding status of the telemetry config feature for the organization.
	Status types.Status

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTelemetryEvaluationStatusInput 

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

type GetTelemetryEvaluationStatusOutput 

type GetTelemetryEvaluationStatusOutput struct {

	//  Describes the reason for the failure status. The field will only be populated
	// if Status is FAILED_START or FAILED_STOP .
	FailureReason *string

	//  The onboarding status of the telemetry config feature.
	Status types.Status

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListResourceTelemetryAPIClient 

type ListResourceTelemetryAPIClient interface {
	ListResourceTelemetry(context.Context, *ListResourceTelemetryInput, ...func(*Options)) (*ListResourceTelemetryOutput, error)
}

ListResourceTelemetryAPIClient is a client that implements the ListResourceTelemetry operation.

type ListResourceTelemetryForOrganizationAPIClient 

type ListResourceTelemetryForOrganizationAPIClient interface {
	ListResourceTelemetryForOrganization(context.Context, *ListResourceTelemetryForOrganizationInput, ...func(*Options)) (*ListResourceTelemetryForOrganizationOutput, error)
}

ListResourceTelemetryForOrganizationAPIClient is a client that implements the ListResourceTelemetryForOrganization operation.

type ListResourceTelemetryForOrganizationInput 

type ListResourceTelemetryForOrganizationInput struct {

	//  A list of AWS account IDs used to filter the resources to those associated
	// with the specified accounts.
	AccountIdentifiers []string

	//  A number field used to limit the number of results within the returned list.
	MaxResults *int32

	//  The token for the next set of items to return. A previous call provides this
	// token.
	NextToken *string

	//  A string used to filter resources in the organization which have a
	// ResourceIdentifier starting with the ResourceIdentifierPrefix .
	ResourceIdentifierPrefix *string

	//  A key-value pair to filter resources in the organization based on tags
	// associated with the resource. Fore more information about tags, see [What are tags?]
	//
	// [What are tags?]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html
	ResourceTags map[string]string

	//  A list of resource types used to filter resources in the organization. If this
	// parameter is provided, the resources will be returned in the same order used in
	// the request.
	ResourceTypes []types.ResourceType

	//  A key-value pair to filter resources in the organization based on the
	// telemetry type and the state of the telemetry configuration. The key is the
	// telemetry type and the value is the state.
	TelemetryConfigurationState map[string]types.TelemetryState
	// contains filtered or unexported fields
}

type ListResourceTelemetryForOrganizationOutput 

type ListResourceTelemetryForOrganizationOutput struct {

	//  The token for the next set of items to return. A previous call provides this
	// token.
	NextToken *string

	//  A list of telemetry configurations for AWS resources supported by telemetry
	// config in the organization.
	TelemetryConfigurations []types.TelemetryConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourceTelemetryForOrganizationPaginator 

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

ListResourceTelemetryForOrganizationPaginator is a paginator for ListResourceTelemetryForOrganization

func NewListResourceTelemetryForOrganizationPaginator 

func NewListResourceTelemetryForOrganizationPaginator(client ListResourceTelemetryForOrganizationAPIClient, params *ListResourceTelemetryForOrganizationInput, optFns ...func(*ListResourceTelemetryForOrganizationPaginatorOptions)) *ListResourceTelemetryForOrganizationPaginator

NewListResourceTelemetryForOrganizationPaginator returns a new ListResourceTelemetryForOrganizationPaginator

func (*ListResourceTelemetryForOrganizationPaginator) HasMorePages 

func (p *ListResourceTelemetryForOrganizationPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourceTelemetryForOrganizationPaginator) NextPage 

func (p *ListResourceTelemetryForOrganizationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceTelemetryForOrganizationOutput, error)

NextPage retrieves the next ListResourceTelemetryForOrganization page.

type ListResourceTelemetryForOrganizationPaginatorOptions 

type ListResourceTelemetryForOrganizationPaginatorOptions struct {
	//  A number field used to limit the number of results within the returned list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourceTelemetryForOrganizationPaginatorOptions is the paginator options for ListResourceTelemetryForOrganization

type ListResourceTelemetryInput 

type ListResourceTelemetryInput struct {

	//  A number field used to limit the number of results within the returned list.
	MaxResults *int32

	//  The token for the next set of items to return. A previous call generates this
	// token.
	NextToken *string

	//  A string used to filter resources which have a ResourceIdentifier starting
	// with the ResourceIdentifierPrefix .
	ResourceIdentifierPrefix *string

	//  A key-value pair to filter resources based on tags associated with the
	// resource. For more information about tags, see [What are tags?]
	//
	// [What are tags?]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html
	ResourceTags map[string]string

	//  A list of resource types used to filter resources supported by telemetry
	// config. If this parameter is provided, the resources will be returned in the
	// same order used in the request.
	ResourceTypes []types.ResourceType

	//  A key-value pair to filter resources based on the telemetry type and the state
	// of the telemetry configuration. The key is the telemetry type and the value is
	// the state.
	TelemetryConfigurationState map[string]types.TelemetryState
	// contains filtered or unexported fields
}

type ListResourceTelemetryOutput 

type ListResourceTelemetryOutput struct {

	//  The token for the next set of items to return. A previous call generates this
	// token.
	NextToken *string

	//  A list of telemetry configurations for AWS resources supported by telemetry
	// config in the caller's account.
	TelemetryConfigurations []types.TelemetryConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourceTelemetryPaginator 

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

ListResourceTelemetryPaginator is a paginator for ListResourceTelemetry

func NewListResourceTelemetryPaginator 

func NewListResourceTelemetryPaginator(client ListResourceTelemetryAPIClient, params *ListResourceTelemetryInput, optFns ...func(*ListResourceTelemetryPaginatorOptions)) *ListResourceTelemetryPaginator

NewListResourceTelemetryPaginator returns a new ListResourceTelemetryPaginator

func (*ListResourceTelemetryPaginator) HasMorePages 

func (p *ListResourceTelemetryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourceTelemetryPaginator) NextPage 

func (p *ListResourceTelemetryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceTelemetryOutput, error)

NextPage retrieves the next ListResourceTelemetry page.

type ListResourceTelemetryPaginatorOptions 

type ListResourceTelemetryPaginatorOptions struct {
	//  A number field used to limit the number of results within the returned list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourceTelemetryPaginatorOptions is the paginator options for ListResourceTelemetry

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartTelemetryEvaluationForOrganizationInput 

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

type StartTelemetryEvaluationForOrganizationOutput 

type StartTelemetryEvaluationForOrganizationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartTelemetryEvaluationInput 

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

type StartTelemetryEvaluationOutput 

type StartTelemetryEvaluationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopTelemetryEvaluationForOrganizationInput 

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

type StopTelemetryEvaluationForOrganizationOutput 

type StopTelemetryEvaluationForOrganizationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopTelemetryEvaluationInput 

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

type StopTelemetryEvaluationOutput 

type StopTelemetryEvaluationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.