observabilityadmin

package module
v1.7.1 Latest Latest
Warning

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

Go to latest
Published: Sep 23, 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.

You can use Amazon CloudWatch Observability Admin to discover and understand

the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment. 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) CreateCentralizationRuleForOrganization added in v1.7.1

func (c *Client) CreateCentralizationRuleForOrganization(ctx context.Context, params *CreateCentralizationRuleForOrganizationInput, optFns ...func(*Options)) (*CreateCentralizationRuleForOrganizationOutput, error)

Creates a centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

func (*Client) CreateTelemetryRule added in v1.3.0

func (c *Client) CreateTelemetryRule(ctx context.Context, params *CreateTelemetryRuleInput, optFns ...func(*Options)) (*CreateTelemetryRuleOutput, error)
Creates a telemetry rule that defines how telemetry should be configured for

Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

func (*Client) CreateTelemetryRuleForOrganization added in v1.3.0

func (c *Client) CreateTelemetryRuleForOrganization(ctx context.Context, params *CreateTelemetryRuleForOrganizationInput, optFns ...func(*Options)) (*CreateTelemetryRuleForOrganizationOutput, error)
Creates a telemetry rule that applies across an Amazon Web Services

Organization. This operation can only be called by the organization's management account or a delegated administrator account.

func (*Client) DeleteCentralizationRuleForOrganization added in v1.7.1

func (c *Client) DeleteCentralizationRuleForOrganization(ctx context.Context, params *DeleteCentralizationRuleForOrganizationInput, optFns ...func(*Options)) (*DeleteCentralizationRuleForOrganizationOutput, error)

Deletes an organization-wide centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

func (*Client) DeleteTelemetryRule added in v1.3.0

func (c *Client) DeleteTelemetryRule(ctx context.Context, params *DeleteTelemetryRuleInput, optFns ...func(*Options)) (*DeleteTelemetryRuleOutput, error)
Deletes a telemetry rule from your account. Any telemetry configurations

previously created by the rule will remain but no new resources will be configured by this rule.

func (*Client) DeleteTelemetryRuleForOrganization added in v1.3.0

func (c *Client) DeleteTelemetryRuleForOrganization(ctx context.Context, params *DeleteTelemetryRuleForOrganizationInput, optFns ...func(*Options)) (*DeleteTelemetryRuleForOrganizationOutput, error)
Deletes an organization-wide telemetry rule. This operation can only be called

by the organization's management account or a delegated administrator account.

func (*Client) GetCentralizationRuleForOrganization added in v1.7.1

func (c *Client) GetCentralizationRuleForOrganization(ctx context.Context, params *GetCentralizationRuleForOrganizationInput, optFns ...func(*Options)) (*GetCentralizationRuleForOrganizationOutput, error)

Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

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 Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config.

func (*Client) GetTelemetryRule added in v1.3.0

func (c *Client) GetTelemetryRule(ctx context.Context, params *GetTelemetryRuleInput, optFns ...func(*Options)) (*GetTelemetryRuleOutput, error)

Retrieves the details of a specific telemetry rule in your account.

func (*Client) GetTelemetryRuleForOrganization added in v1.3.0

func (c *Client) GetTelemetryRuleForOrganization(ctx context.Context, params *GetTelemetryRuleForOrganizationInput, optFns ...func(*Options)) (*GetTelemetryRuleForOrganizationOutput, error)
Retrieves the details of a specific organization telemetry rule. This

operation can only be called by the organization's management account or a delegated administrator account.

func (*Client) ListCentralizationRulesForOrganization added in v1.7.1

func (c *Client) ListCentralizationRulesForOrganization(ctx context.Context, params *ListCentralizationRulesForOrganizationInput, optFns ...func(*Options)) (*ListCentralizationRulesForOrganizationOutput, error)

Lists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

func (*Client) ListResourceTelemetry

func (c *Client) ListResourceTelemetry(ctx context.Context, params *ListResourceTelemetryInput, optFns ...func(*Options)) (*ListResourceTelemetryOutput, error)
Returns a list of telemetry configurations for Amazon Web Services 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 Amazon Web Services resources

supported by telemetry config in the organization.

func (*Client) ListTagsForResource added in v1.3.0

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags attached to the specified telemetry rule resource.

func (*Client) ListTelemetryRules added in v1.3.0

func (c *Client) ListTelemetryRules(ctx context.Context, params *ListTelemetryRulesInput, optFns ...func(*Options)) (*ListTelemetryRulesOutput, error)
Lists all telemetry rules in your account. You can filter the results by

specifying a rule name prefix.

func (*Client) ListTelemetryRulesForOrganization added in v1.3.0

func (c *Client) ListTelemetryRulesForOrganization(ctx context.Context, params *ListTelemetryRulesForOrganizationInput, optFns ...func(*Options)) (*ListTelemetryRulesForOrganizationOutput, error)
Lists all telemetry rules in your organization. This operation can only be

called by the organization's management account or a delegated administrator account.

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 the caller Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services

account from the telemetry config feature.

func (*Client) TagResource added in v1.3.0

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds or updates tags for a telemetry rule resource.

func (*Client) UntagResource added in v1.3.0

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a telemetry rule resource.

func (*Client) UpdateCentralizationRuleForOrganization added in v1.7.1

func (c *Client) UpdateCentralizationRuleForOrganization(ctx context.Context, params *UpdateCentralizationRuleForOrganizationInput, optFns ...func(*Options)) (*UpdateCentralizationRuleForOrganizationOutput, error)

Updates an existing centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

func (*Client) UpdateTelemetryRule added in v1.3.0

func (c *Client) UpdateTelemetryRule(ctx context.Context, params *UpdateTelemetryRuleInput, optFns ...func(*Options)) (*UpdateTelemetryRuleOutput, error)

Updates an existing telemetry rule in your account.

func (*Client) UpdateTelemetryRuleForOrganization added in v1.3.0

func (c *Client) UpdateTelemetryRuleForOrganization(ctx context.Context, params *UpdateTelemetryRuleForOrganizationInput, optFns ...func(*Options)) (*UpdateTelemetryRuleForOrganizationOutput, error)
Updates an existing telemetry rule that applies across an Amazon Web Services

Organization. This operation can only be called by the organization's management account or a delegated administrator account.

type CreateCentralizationRuleForOrganizationInput added in v1.7.1

type CreateCentralizationRuleForOrganizationInput struct {

	// The configuration details for the organization-wide centralization rule,
	// including the source configuration and the destination configuration to
	// centralize telemetry data across the organization.
	//
	// This member is required.
	Rule *types.CentralizationRule

	// A unique name for the organization-wide centralization rule being created.
	//
	// This member is required.
	RuleName *string

	// The key-value pairs to associate with the organization telemetry rule resource
	// for categorization and management purposes.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateCentralizationRuleForOrganizationOutput added in v1.7.1

type CreateCentralizationRuleForOrganizationOutput struct {

	// The Amazon Resource Name (ARN) of the created organization centralization rule.
	RuleArn *string

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

type CreateTelemetryRuleForOrganizationInput added in v1.3.0

type CreateTelemetryRuleForOrganizationInput struct {

	//  The configuration details for the organization-wide telemetry rule, including
	// the resource type, telemetry type, destination configuration, and selection
	// criteria for which resources the rule applies to across the organization.
	//
	// This member is required.
	Rule *types.TelemetryRule

	//  A unique name for the organization-wide telemetry rule being created.
	//
	// This member is required.
	RuleName *string

	//  The key-value pairs to associate with the organization telemetry rule resource
	// for categorization and management purposes.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateTelemetryRuleForOrganizationOutput added in v1.3.0

type CreateTelemetryRuleForOrganizationOutput struct {

	//  The Amazon Resource Name (ARN) of the created organization telemetry rule.
	RuleArn *string

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

type CreateTelemetryRuleInput added in v1.3.0

type CreateTelemetryRuleInput struct {

	//  The configuration details for the telemetry rule, including the resource type,
	// telemetry type, destination configuration, and selection criteria for which
	// resources the rule applies to.
	//
	// This member is required.
	Rule *types.TelemetryRule

	//  A unique name for the telemetry rule being created.
	//
	// This member is required.
	RuleName *string

	//  The key-value pairs to associate with the telemetry rule resource for
	// categorization and management purposes.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateTelemetryRuleOutput added in v1.3.0

type CreateTelemetryRuleOutput struct {

	//  The Amazon Resource Name (ARN) of the created telemetry rule.
	RuleArn *string

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

type DeleteCentralizationRuleForOrganizationInput added in v1.7.1

type DeleteCentralizationRuleForOrganizationInput struct {

	// The identifier (name or ARN) of the organization centralization rule to delete.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type DeleteCentralizationRuleForOrganizationOutput added in v1.7.1

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

type DeleteTelemetryRuleForOrganizationInput added in v1.3.0

type DeleteTelemetryRuleForOrganizationInput struct {

	//  The identifier (name or ARN) of the organization telemetry rule to delete.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type DeleteTelemetryRuleForOrganizationOutput added in v1.3.0

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

type DeleteTelemetryRuleInput added in v1.3.0

type DeleteTelemetryRuleInput struct {

	//  The identifier (name or ARN) of the telemetry rule to delete.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type DeleteTelemetryRuleOutput added in v1.3.0

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

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 GetCentralizationRuleForOrganizationInput added in v1.7.1

type GetCentralizationRuleForOrganizationInput struct {

	// The identifier (name or ARN) of the organization centralization rule to
	// retrieve.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type GetCentralizationRuleForOrganizationOutput added in v1.7.1

type GetCentralizationRuleForOrganizationOutput struct {

	// The configuration details for the organization centralization rule.
	CentralizationRule *types.CentralizationRule

	// The Amazon Web Services region where the organization centralization rule was
	// created.
	CreatedRegion *string

	// The timestamp when the organization centralization rule was created.
	CreatedTimeStamp *int64

	// The Amazon Web Services Account that created the organization centralization
	// rule.
	CreatorAccountId *string

	// The reason why an organization centralization rule is marked UNHEALTHY.
	FailureReason types.CentralizationFailureReason

	// The timestamp when the organization centralization rule was last updated.
	LastUpdateTimeStamp *int64

	// The Amazon Resource Name (ARN) of the organization centralization rule.
	RuleArn *string

	// The health status of the organization centralization rule.
	RuleHealth types.RuleHealth

	// The name of the organization centralization rule.
	RuleName *string

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

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 GetTelemetryRuleForOrganizationInput added in v1.3.0

type GetTelemetryRuleForOrganizationInput struct {

	//  The identifier (name or ARN) of the organization telemetry rule to retrieve.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type GetTelemetryRuleForOrganizationOutput added in v1.3.0

type GetTelemetryRuleForOrganizationOutput struct {

	//  The timestamp when the organization telemetry rule was created.
	CreatedTimeStamp *int64

	//  The timestamp when the organization telemetry rule was last updated.
	LastUpdateTimeStamp *int64

	//  The Amazon Resource Name (ARN) of the organization telemetry rule.
	RuleArn *string

	//  The name of the organization telemetry rule.
	RuleName *string

	//  The configuration details of the organization telemetry rule.
	TelemetryRule *types.TelemetryRule

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

type GetTelemetryRuleInput added in v1.3.0

type GetTelemetryRuleInput struct {

	//  The identifier (name or ARN) of the telemetry rule to retrieve.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type GetTelemetryRuleOutput added in v1.3.0

type GetTelemetryRuleOutput struct {

	//  The timestamp when the telemetry rule was created.
	CreatedTimeStamp *int64

	//  The timestamp when the telemetry rule was last updated.
	LastUpdateTimeStamp *int64

	//  The Amazon Resource Name (ARN) of the telemetry rule.
	RuleArn *string

	//  The name of the telemetry rule.
	RuleName *string

	//  The configuration details of the telemetry rule.
	TelemetryRule *types.TelemetryRule

	// 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 ListCentralizationRulesForOrganizationAPIClient added in v1.7.1

type ListCentralizationRulesForOrganizationAPIClient interface {
	ListCentralizationRulesForOrganization(context.Context, *ListCentralizationRulesForOrganizationInput, ...func(*Options)) (*ListCentralizationRulesForOrganizationOutput, error)
}

ListCentralizationRulesForOrganizationAPIClient is a client that implements the ListCentralizationRulesForOrganization operation.

type ListCentralizationRulesForOrganizationInput added in v1.7.1

type ListCentralizationRulesForOrganizationInput struct {

	// A flag determining whether to return organization centralization rules from all
	// regions or only the current region.
	AllRegions *bool

	// The maximum number of organization centralization rules to return in a single
	// call.
	MaxResults *int32

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

	// A string to filter organization centralization rules whose names begin with the
	// specified prefix.
	RuleNamePrefix *string
	// contains filtered or unexported fields
}

type ListCentralizationRulesForOrganizationOutput added in v1.7.1

type ListCentralizationRulesForOrganizationOutput struct {

	// A list of centralization rule summaries.
	CentralizationRuleSummaries []types.CentralizationRuleSummary

	// A token to resume pagination of results.
	NextToken *string

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

type ListCentralizationRulesForOrganizationPaginator added in v1.7.1

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

ListCentralizationRulesForOrganizationPaginator is a paginator for ListCentralizationRulesForOrganization

func NewListCentralizationRulesForOrganizationPaginator added in v1.7.1

NewListCentralizationRulesForOrganizationPaginator returns a new ListCentralizationRulesForOrganizationPaginator

func (*ListCentralizationRulesForOrganizationPaginator) HasMorePages added in v1.7.1

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCentralizationRulesForOrganizationPaginator) NextPage added in v1.7.1

NextPage retrieves the next ListCentralizationRulesForOrganization page.

type ListCentralizationRulesForOrganizationPaginatorOptions added in v1.7.1

type ListCentralizationRulesForOrganizationPaginatorOptions struct {
	// The maximum number of organization centralization rules to return in a single
	// call.
	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
}

ListCentralizationRulesForOrganizationPaginatorOptions is the paginator options for ListCentralizationRulesForOrganization

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 Amazon Web Services accounts 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 Amazon Web Services 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

NewListResourceTelemetryForOrganizationPaginator returns a new ListResourceTelemetryForOrganizationPaginator

func (*ListResourceTelemetryForOrganizationPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourceTelemetryForOrganizationPaginator) NextPage

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 Amazon Web Services 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

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

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 ListTagsForResourceInput added in v1.3.0

type ListTagsForResourceInput struct {

	//  The Amazon Resource Name (ARN) of the telemetry rule resource whose tags you
	// want to list.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.3.0

type ListTagsForResourceOutput struct {

	//  The list of tags associated with the telemetry rule resource.
	//
	// This member is required.
	Tags map[string]string

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

type ListTelemetryRulesAPIClient added in v1.3.0

type ListTelemetryRulesAPIClient interface {
	ListTelemetryRules(context.Context, *ListTelemetryRulesInput, ...func(*Options)) (*ListTelemetryRulesOutput, error)
}

ListTelemetryRulesAPIClient is a client that implements the ListTelemetryRules operation.

type ListTelemetryRulesForOrganizationAPIClient added in v1.3.0

type ListTelemetryRulesForOrganizationAPIClient interface {
	ListTelemetryRulesForOrganization(context.Context, *ListTelemetryRulesForOrganizationInput, ...func(*Options)) (*ListTelemetryRulesForOrganizationOutput, error)
}

ListTelemetryRulesForOrganizationAPIClient is a client that implements the ListTelemetryRulesForOrganization operation.

type ListTelemetryRulesForOrganizationInput added in v1.3.0

type ListTelemetryRulesForOrganizationInput struct {

	//  The maximum number of organization telemetry rules to return in a single call.
	MaxResults *int32

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

	//  A string to filter organization telemetry rules whose names begin with the
	// specified prefix.
	RuleNamePrefix *string

	//  The list of account IDs to filter organization telemetry rules by their source
	// accounts.
	SourceAccountIds []string

	//  The list of organizational unit IDs to filter organization telemetry rules by
	// their source organizational units.
	SourceOrganizationUnitIds []string
	// contains filtered or unexported fields
}

type ListTelemetryRulesForOrganizationOutput added in v1.3.0

type ListTelemetryRulesForOrganizationOutput struct {

	//  A token to resume pagination of results.
	NextToken *string

	//  A list of organization telemetry rule summaries.
	TelemetryRuleSummaries []types.TelemetryRuleSummary

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

type ListTelemetryRulesForOrganizationPaginator added in v1.3.0

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

ListTelemetryRulesForOrganizationPaginator is a paginator for ListTelemetryRulesForOrganization

func NewListTelemetryRulesForOrganizationPaginator added in v1.3.0

NewListTelemetryRulesForOrganizationPaginator returns a new ListTelemetryRulesForOrganizationPaginator

func (*ListTelemetryRulesForOrganizationPaginator) HasMorePages added in v1.3.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTelemetryRulesForOrganizationPaginator) NextPage added in v1.3.0

NextPage retrieves the next ListTelemetryRulesForOrganization page.

type ListTelemetryRulesForOrganizationPaginatorOptions added in v1.3.0

type ListTelemetryRulesForOrganizationPaginatorOptions struct {
	//  The maximum number of organization telemetry rules to return in a single call.
	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
}

ListTelemetryRulesForOrganizationPaginatorOptions is the paginator options for ListTelemetryRulesForOrganization

type ListTelemetryRulesInput added in v1.3.0

type ListTelemetryRulesInput struct {

	//  The maximum number of telemetry rules to return in a single call.
	MaxResults *int32

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

	//  A string to filter telemetry rules whose names begin with the specified
	// prefix.
	RuleNamePrefix *string
	// contains filtered or unexported fields
}

type ListTelemetryRulesOutput added in v1.3.0

type ListTelemetryRulesOutput struct {

	//  A token to resume pagination of results.
	NextToken *string

	//  A list of telemetry rule summaries.
	TelemetryRuleSummaries []types.TelemetryRuleSummary

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

type ListTelemetryRulesPaginator added in v1.3.0

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

ListTelemetryRulesPaginator is a paginator for ListTelemetryRules

func NewListTelemetryRulesPaginator added in v1.3.0

func NewListTelemetryRulesPaginator(client ListTelemetryRulesAPIClient, params *ListTelemetryRulesInput, optFns ...func(*ListTelemetryRulesPaginatorOptions)) *ListTelemetryRulesPaginator

NewListTelemetryRulesPaginator returns a new ListTelemetryRulesPaginator

func (*ListTelemetryRulesPaginator) HasMorePages added in v1.3.0

func (p *ListTelemetryRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTelemetryRulesPaginator) NextPage added in v1.3.0

func (p *ListTelemetryRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTelemetryRulesOutput, error)

NextPage retrieves the next ListTelemetryRules page.

type ListTelemetryRulesPaginatorOptions added in v1.3.0

type ListTelemetryRulesPaginatorOptions struct {
	//  The maximum number of telemetry rules to return in a single call.
	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
}

ListTelemetryRulesPaginatorOptions is the paginator options for ListTelemetryRules

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

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

	// 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

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// 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 (*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
}

type TagResourceInput added in v1.3.0

type TagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the telemetry rule resource to tag.
	//
	// This member is required.
	ResourceARN *string

	//  The key-value pairs to add or update for the telemetry rule resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.3.0

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

type UntagResourceInput added in v1.3.0

type UntagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the telemetry rule resource to remove tags
	// from.
	//
	// This member is required.
	ResourceARN *string

	//  The list of tag keys to remove from the telemetry rule resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v1.3.0

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

type UpdateCentralizationRuleForOrganizationInput added in v1.7.1

type UpdateCentralizationRuleForOrganizationInput struct {

	// The configuration details for the organization-wide centralization rule,
	// including the source configuration and the destination configuration to
	// centralize telemetry data across the organization.
	//
	// This member is required.
	Rule *types.CentralizationRule

	// The identifier (name or ARN) of the organization centralization rule to update.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type UpdateCentralizationRuleForOrganizationOutput added in v1.7.1

type UpdateCentralizationRuleForOrganizationOutput struct {

	// The Amazon Resource Name (ARN) of the updated organization centralization rule.
	RuleArn *string

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

type UpdateTelemetryRuleForOrganizationInput added in v1.3.0

type UpdateTelemetryRuleForOrganizationInput struct {

	//  The new configuration details for the organization telemetry rule, including
	// resource type, telemetry type, and destination configuration.
	//
	// This member is required.
	Rule *types.TelemetryRule

	//  The identifier (name or ARN) of the organization telemetry rule to update.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type UpdateTelemetryRuleForOrganizationOutput added in v1.3.0

type UpdateTelemetryRuleForOrganizationOutput struct {

	//  The Amazon Resource Name (ARN) of the updated organization telemetry rule.
	RuleArn *string

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

type UpdateTelemetryRuleInput added in v1.3.0

type UpdateTelemetryRuleInput struct {

	//  The new configuration details for the telemetry rule.
	//
	// This member is required.
	Rule *types.TelemetryRule

	//  The identifier (name or ARN) of the telemetry rule to update.
	//
	// This member is required.
	RuleIdentifier *string
	// contains filtered or unexported fields
}

type UpdateTelemetryRuleOutput added in v1.3.0

type UpdateTelemetryRuleOutput struct {

	//  The Amazon Resource Name (ARN) of the updated telemetry rule.
	RuleArn *string

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

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL