Documentation
¶
Overview ¶
Package computeoptimizerautomation provides the API client, operations, and parameter types for Compute Optimizer Automation.
Automation is a feature within Amazon Web Services Compute Optimizer that
enables you to apply optimization recommendations to your Amazon Web Services resources, reducing costs and improving performance. You can apply recommended actions directly or create automation rules that implement recommendations on a recurring schedule when they match your specified criteria. With automation rules, set criteria such as Amazon Web Services Region and Resource Tags to target specific geographies and workloads. Configure rules to run daily, weekly, or monthly, and Compute Optimizer continuously evaluates new recommendations against your criteria. Track automation events over time, examine detailed step history, estimate savings achieved, and reverse actions directly from Compute Optimizer when needed.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AssociateAccountsInput
- type AssociateAccountsOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) AssociateAccounts(ctx context.Context, params *AssociateAccountsInput, optFns ...func(*Options)) (*AssociateAccountsOutput, error)
- func (c *Client) CreateAutomationRule(ctx context.Context, params *CreateAutomationRuleInput, ...) (*CreateAutomationRuleOutput, error)
- func (c *Client) DeleteAutomationRule(ctx context.Context, params *DeleteAutomationRuleInput, ...) (*DeleteAutomationRuleOutput, error)
- func (c *Client) DisassociateAccounts(ctx context.Context, params *DisassociateAccountsInput, ...) (*DisassociateAccountsOutput, error)
- func (c *Client) GetAutomationEvent(ctx context.Context, params *GetAutomationEventInput, optFns ...func(*Options)) (*GetAutomationEventOutput, error)
- func (c *Client) GetAutomationRule(ctx context.Context, params *GetAutomationRuleInput, optFns ...func(*Options)) (*GetAutomationRuleOutput, error)
- func (c *Client) GetEnrollmentConfiguration(ctx context.Context, params *GetEnrollmentConfigurationInput, ...) (*GetEnrollmentConfigurationOutput, error)
- func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, optFns ...func(*Options)) (*ListAccountsOutput, error)
- func (c *Client) ListAutomationEventSteps(ctx context.Context, params *ListAutomationEventStepsInput, ...) (*ListAutomationEventStepsOutput, error)
- func (c *Client) ListAutomationEventSummaries(ctx context.Context, params *ListAutomationEventSummariesInput, ...) (*ListAutomationEventSummariesOutput, error)
- func (c *Client) ListAutomationEvents(ctx context.Context, params *ListAutomationEventsInput, ...) (*ListAutomationEventsOutput, error)
- func (c *Client) ListAutomationRulePreview(ctx context.Context, params *ListAutomationRulePreviewInput, ...) (*ListAutomationRulePreviewOutput, error)
- func (c *Client) ListAutomationRulePreviewSummaries(ctx context.Context, params *ListAutomationRulePreviewSummariesInput, ...) (*ListAutomationRulePreviewSummariesOutput, error)
- func (c *Client) ListAutomationRules(ctx context.Context, params *ListAutomationRulesInput, ...) (*ListAutomationRulesOutput, error)
- func (c *Client) ListRecommendedActionSummaries(ctx context.Context, params *ListRecommendedActionSummariesInput, ...) (*ListRecommendedActionSummariesOutput, error)
- func (c *Client) ListRecommendedActions(ctx context.Context, params *ListRecommendedActionsInput, ...) (*ListRecommendedActionsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) RollbackAutomationEvent(ctx context.Context, params *RollbackAutomationEventInput, ...) (*RollbackAutomationEventOutput, error)
- func (c *Client) StartAutomationEvent(ctx context.Context, params *StartAutomationEventInput, ...) (*StartAutomationEventOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateAutomationRule(ctx context.Context, params *UpdateAutomationRuleInput, ...) (*UpdateAutomationRuleOutput, error)
- func (c *Client) UpdateEnrollmentConfiguration(ctx context.Context, params *UpdateEnrollmentConfigurationInput, ...) (*UpdateEnrollmentConfigurationOutput, error)
- type CreateAutomationRuleInput
- type CreateAutomationRuleOutput
- type DeleteAutomationRuleInput
- type DeleteAutomationRuleOutput
- type DisassociateAccountsInput
- type DisassociateAccountsOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetAutomationEventInput
- type GetAutomationEventOutput
- type GetAutomationRuleInput
- type GetAutomationRuleOutput
- type GetEnrollmentConfigurationInput
- type GetEnrollmentConfigurationOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListAccountsAPIClient
- type ListAccountsInput
- type ListAccountsOutput
- type ListAccountsPaginator
- type ListAccountsPaginatorOptions
- type ListAutomationEventStepsAPIClient
- type ListAutomationEventStepsInput
- type ListAutomationEventStepsOutput
- type ListAutomationEventStepsPaginator
- type ListAutomationEventStepsPaginatorOptions
- type ListAutomationEventSummariesAPIClient
- type ListAutomationEventSummariesInput
- type ListAutomationEventSummariesOutput
- type ListAutomationEventSummariesPaginator
- type ListAutomationEventSummariesPaginatorOptions
- type ListAutomationEventsAPIClient
- type ListAutomationEventsInput
- type ListAutomationEventsOutput
- type ListAutomationEventsPaginator
- type ListAutomationEventsPaginatorOptions
- type ListAutomationRulePreviewAPIClient
- type ListAutomationRulePreviewInput
- type ListAutomationRulePreviewOutput
- type ListAutomationRulePreviewPaginator
- type ListAutomationRulePreviewPaginatorOptions
- type ListAutomationRulePreviewSummariesAPIClient
- type ListAutomationRulePreviewSummariesInput
- type ListAutomationRulePreviewSummariesOutput
- type ListAutomationRulePreviewSummariesPaginator
- type ListAutomationRulePreviewSummariesPaginatorOptions
- type ListAutomationRulesAPIClient
- type ListAutomationRulesInput
- type ListAutomationRulesOutput
- type ListAutomationRulesPaginator
- type ListAutomationRulesPaginatorOptions
- type ListRecommendedActionSummariesAPIClient
- type ListRecommendedActionSummariesInput
- type ListRecommendedActionSummariesOutput
- type ListRecommendedActionSummariesPaginator
- type ListRecommendedActionSummariesPaginatorOptions
- type ListRecommendedActionsAPIClient
- type ListRecommendedActionsInput
- type ListRecommendedActionsOutput
- type ListRecommendedActionsPaginator
- type ListRecommendedActionsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- type RollbackAutomationEventInput
- type RollbackAutomationEventOutput
- type StartAutomationEventInput
- type StartAutomationEventOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAutomationRuleInput
- type UpdateAutomationRuleOutput
- type UpdateEnrollmentConfigurationInput
- type UpdateEnrollmentConfigurationOutput
Constants ¶
const ServiceAPIVersion = "2025-09-22"
const ServiceID = "Compute Optimizer Automation"
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 ¶
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 ¶
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 AssociateAccountsInput ¶
type AssociateAccountsInput struct {
// The IDs of the member accounts to associate. You can specify up to 50 account
// IDs.
//
// This member is required.
AccountIds []string
// A unique identifier to ensure idempotency of the request. Valid for 24 hours
// after creation.
ClientToken *string
// contains filtered or unexported fields
}
type AssociateAccountsOutput ¶
type AssociateAccountsOutput struct {
// The IDs of the member accounts that were successfully associated.
AccountIds []string
// Any errors that occurred during the association process.
Errors []string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
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 Compute Optimizer Automation.
func New ¶
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 ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateAccounts ¶
func (c *Client) AssociateAccounts(ctx context.Context, params *AssociateAccountsInput, optFns ...func(*Options)) (*AssociateAccountsOutput, error)
Associates one or more member accounts with your organization's management account, enabling centralized implementation of optimization actions across those accounts. Once associated, the management account (or a delegated administrator) can apply recommended actions to the member account. When you associate a member account, its organization rule mode is automatically set to "Any allowed," which permits the management account to create Automation rules that automatically apply actions to that account. If the member account has not previously enabled the Automation feature, the association process automatically enables it.
Only the management account or a delegated administrator can perform this action.
func (*Client) CreateAutomationRule ¶
func (c *Client) CreateAutomationRule(ctx context.Context, params *CreateAutomationRuleInput, optFns ...func(*Options)) (*CreateAutomationRuleOutput, error)
Creates a new automation rule to apply recommended actions to resources based
on specified criteria.
func (*Client) DeleteAutomationRule ¶
func (c *Client) DeleteAutomationRule(ctx context.Context, params *DeleteAutomationRuleInput, optFns ...func(*Options)) (*DeleteAutomationRuleOutput, error)
Deletes an existing automation rule.
func (*Client) DisassociateAccounts ¶
func (c *Client) DisassociateAccounts(ctx context.Context, params *DisassociateAccountsInput, optFns ...func(*Options)) (*DisassociateAccountsOutput, error)
Disassociates member accounts from your organization's management account,
removing centralized automation capabilities. Once disassociated, organization rules no longer apply to the member account, and the management account (or delegated administrator) cannot create Automation rules for that account.
Only the management account or a delegated administrator can perform this action.
func (*Client) GetAutomationEvent ¶
func (c *Client) GetAutomationEvent(ctx context.Context, params *GetAutomationEventInput, optFns ...func(*Options)) (*GetAutomationEventOutput, error)
Retrieves details about a specific automation event.
func (*Client) GetAutomationRule ¶
func (c *Client) GetAutomationRule(ctx context.Context, params *GetAutomationRuleInput, optFns ...func(*Options)) (*GetAutomationRuleOutput, error)
Retrieves details about a specific automation rule.
func (*Client) GetEnrollmentConfiguration ¶
func (c *Client) GetEnrollmentConfiguration(ctx context.Context, params *GetEnrollmentConfigurationInput, optFns ...func(*Options)) (*GetEnrollmentConfigurationOutput, error)
Retrieves the current enrollment configuration for Compute Optimizer
Automation.
func (*Client) ListAccounts ¶
func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, optFns ...func(*Options)) (*ListAccountsOutput, error)
Lists the accounts in your organization that are enrolled in Compute Optimizer
and whether they have enabled Automation.
Only the management account or a delegated administrator can perform this action.
func (*Client) ListAutomationEventSteps ¶
func (c *Client) ListAutomationEventSteps(ctx context.Context, params *ListAutomationEventStepsInput, optFns ...func(*Options)) (*ListAutomationEventStepsOutput, error)
Lists the steps for a specific automation event. You can only list steps for events created within the past year.
func (*Client) ListAutomationEventSummaries ¶
func (c *Client) ListAutomationEventSummaries(ctx context.Context, params *ListAutomationEventSummariesInput, optFns ...func(*Options)) (*ListAutomationEventSummariesOutput, error)
Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary.
func (*Client) ListAutomationEvents ¶
func (c *Client) ListAutomationEvents(ctx context.Context, params *ListAutomationEventsInput, optFns ...func(*Options)) (*ListAutomationEventsOutput, error)
Lists automation events based on specified filters. You can retrieve events that were created within the past year.
func (*Client) ListAutomationRulePreview ¶
func (c *Client) ListAutomationRulePreview(ctx context.Context, params *ListAutomationRulePreviewInput, optFns ...func(*Options)) (*ListAutomationRulePreviewOutput, error)
Returns a preview of the recommended actions that match your Automation rule's configuration and criteria.
func (*Client) ListAutomationRulePreviewSummaries ¶
func (c *Client) ListAutomationRulePreviewSummaries(ctx context.Context, params *ListAutomationRulePreviewSummariesInput, optFns ...func(*Options)) (*ListAutomationRulePreviewSummariesOutput, error)
Returns a summary of the recommended actions that match your rule preview configuration and criteria.
func (*Client) ListAutomationRules ¶
func (c *Client) ListAutomationRules(ctx context.Context, params *ListAutomationRulesInput, optFns ...func(*Options)) (*ListAutomationRulesOutput, error)
Lists the automation rules that match specified filters.
func (*Client) ListRecommendedActionSummaries ¶
func (c *Client) ListRecommendedActionSummaries(ctx context.Context, params *ListRecommendedActionSummariesInput, optFns ...func(*Options)) (*ListRecommendedActionSummariesOutput, error)
Provides a summary of recommended actions based on specified filters.
Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts .
func (*Client) ListRecommendedActions ¶
func (c *Client) ListRecommendedActions(ctx context.Context, params *ListRecommendedActionsInput, optFns ...func(*Options)) (*ListRecommendedActionsOutput, error)
Lists the recommended actions based that match specified filters.
Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts .
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for a specified resource.
func (*Client) 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) RollbackAutomationEvent ¶
func (c *Client) RollbackAutomationEvent(ctx context.Context, params *RollbackAutomationEventInput, optFns ...func(*Options)) (*RollbackAutomationEventOutput, error)
Initiates a rollback for a completed automation event.
Management accounts and delegated administrators can only initiate a rollback for events belonging to associated member accounts. You can associate a member account using AssociateAccounts .
func (*Client) StartAutomationEvent ¶
func (c *Client) StartAutomationEvent(ctx context.Context, params *StartAutomationEventInput, optFns ...func(*Options)) (*StartAutomationEventOutput, error)
Initiates a one-time, on-demand automation for the specified recommended
action.
Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using AssociateAccounts .
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds tags to the specified resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes tags from the specified resource.
func (*Client) UpdateAutomationRule ¶
func (c *Client) UpdateAutomationRule(ctx context.Context, params *UpdateAutomationRuleInput, optFns ...func(*Options)) (*UpdateAutomationRuleOutput, error)
Updates an existing automation rule.
func (*Client) UpdateEnrollmentConfiguration ¶
func (c *Client) UpdateEnrollmentConfiguration(ctx context.Context, params *UpdateEnrollmentConfigurationInput, optFns ...func(*Options)) (*UpdateEnrollmentConfigurationOutput, error)
Updates your account’s Compute Optimizer Automation enrollment configuration.
type CreateAutomationRuleInput ¶
type CreateAutomationRuleInput struct {
// The name of the automation rule.
//
// This member is required.
Name *string
// The types of recommended actions this rule will automate.
//
// This member is required.
RecommendedActionTypes []types.RecommendedActionType
// The type of rule.
//
// Only the management account or a delegated administrator can set the ruleType
// to be OrganizationRule.
//
// This member is required.
RuleType types.RuleType
// The schedule for when the rule should run.
//
// This member is required.
Schedule *types.Schedule
// The status of the rule
//
// This member is required.
Status types.RuleStatus
// A unique identifier to ensure idempotency of the request.
ClientToken *string
// A set of conditions that specify which recommended action qualify for
// implementation. When a rule is active and a recommended action matches these
// criteria, Compute Optimizer implements the action at the scheduled run time.
Criteria *types.Criteria
// A description of the automation rule.
Description *string
// Configuration for organization-level rules. Required for OrganizationRule
// type.
OrganizationConfiguration *types.OrganizationConfiguration
// A string representation of a decimal number between 0 and 1 (having up to 30
// digits after the decimal point) that determines the priority of the rule. When
// multiple rules match the same recommended action, Compute Optimizer assigns the
// action to the rule with the lowest priority value (highest priority), even if
// that rule is scheduled to run later than other matching rules.
Priority *string
// The tags to associate with the rule.
Tags []types.Tag
// contains filtered or unexported fields
}
type CreateAutomationRuleOutput ¶
type CreateAutomationRuleOutput struct {
// The timestamp when the automation rule was created.
CreatedTimestamp *time.Time
// A set of conditions that specify which recommended action qualify for
// implementation. When a rule is active and a recommended action matches these
// criteria, Compute Optimizer implements the action at the scheduled run time. You
// can specify up to 20 conditions per filter criteria and 20 values per condition.
Criteria *types.Criteria
// A description of the automation rule. Can be up to 1024 characters long and
// contain alphanumeric characters, underscores, hyphens, spaces, and certain
// special characters.
Description *string
// The name of the automation rule. Must be 1-128 characters long and contain only
// alphanumeric characters, underscores, and hyphens.
Name *string
// Configuration settings for organization-wide rules, including rule application
// order and target account IDs.
OrganizationConfiguration *types.OrganizationConfiguration
// The priority level of the automation rule, used to determine execution order
// when multiple rules apply to the same resource.
Priority *string
// List of recommended action types that this rule can execute, such as
// SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.
RecommendedActionTypes []types.RecommendedActionType
// The Amazon Resource Name (ARN) of the created rule.
RuleArn *string
// The unique identifier of the created rule.
RuleId *string
// The revision number of the automation rule. This is incremented each time the
// rule is updated.
RuleRevision *int64
// The type of automation rule. Can be either OrganizationRule for
// organization-wide rules or AccountRule for account-specific rules.
RuleType types.RuleType
// The schedule configuration for when the automation rule should execute,
// including cron expression, timezone, and execution window.
Schedule *types.Schedule
// The current status of the automation rule. Can be Active or Inactive.
Status types.RuleStatus
// A list of key-value pairs used to categorize and organize the automation rule.
// Maximum of 200 tags allowed.
Tags []types.Tag
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type DeleteAutomationRuleInput ¶
type DeleteAutomationRuleInput struct {
// The ARN of the rule to delete.
//
// This member is required.
RuleArn *string
// The revision number of the rule to delete.
//
// This member is required.
RuleRevision *int64
// A unique identifier to ensure idempotency of the request.
ClientToken *string
// contains filtered or unexported fields
}
type DeleteAutomationRuleOutput ¶
type DeleteAutomationRuleOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type DisassociateAccountsOutput ¶
type DisassociateAccountsOutput struct {
// The IDs of the member accounts that were successfully disassociated.
AccountIds []string
// Any errors that occurred during the disassociation process.
Errors []string
// 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 GetAutomationEventInput ¶
type GetAutomationEventInput struct {
// The ID of the automation event to retrieve.
//
// This member is required.
EventId *string
// contains filtered or unexported fields
}
type GetAutomationEventOutput ¶
type GetAutomationEventOutput struct {
// The Amazon Web Services account ID associated with the automation event.
AccountId *string
// The timestamp when the automation event completed.
CompletedTimestamp *time.Time
// The timestamp when the automation event was created.
CreatedTimestamp *time.Time
// Contains information about estimated monthly cost savings.
EstimatedMonthlySavings *types.EstimatedMonthlySavings
// A description of the automation event.
EventDescription *string
// The ID of the automation event to retrieve.
EventId *string
// The current status of the automation event.
EventStatus types.EventStatus
// The reason for the current event status.
EventStatusReason *string
// The type of automation event.
EventType types.EventType
// The ID of the recommended action associated with this automation event.
RecommendedActionId *string
// The Amazon Web Services Region where the automation event occurred.
Region *string
// The Amazon Resource Name (ARN) of the resource affected by the automation event.
ResourceArn *string
// The ID of the resource affected by the automation event.
ResourceId *string
// The type of resource affected by the automation event.
ResourceType types.ResourceType
// The ID of the automation rule that triggered this event.
RuleId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type GetAutomationRuleInput ¶
type GetAutomationRuleInput struct {
// The ARN of the rule to retrieve.
//
// This member is required.
RuleArn *string
// contains filtered or unexported fields
}
type GetAutomationRuleOutput ¶
type GetAutomationRuleOutput struct {
// The 12-digit Amazon Web Services account ID that owns this automation rule.
AccountId *string
// The timestamp when the automation rule was created.
CreatedTimestamp *time.Time
// A set of conditions that specify which recommended action qualify for
// implementation. When a rule is active and a recommended action matches these
// criteria, Compute Optimizer implements the action at the scheduled run time. You
// can specify up to 20 conditions per filter criteria and 20 values per condition.
Criteria *types.Criteria
// A description of the automation rule.
Description *string
// The timestamp when the automation rule was last updated.
LastUpdatedTimestamp *time.Time
// The name of the automation rule.
Name *string
// Configuration settings for organization-wide automation rules.
OrganizationConfiguration *types.OrganizationConfiguration
// A string representation of a decimal number between 0 and 1 (having up to 30
// digits after the decimal point) that determines the priority of the rule.
Priority *string
// List of recommended action types that this rule can execute.
RecommendedActionTypes []types.RecommendedActionType
// The Amazon Resource Name (ARN) of the automation rule.
RuleArn *string
// The unique identifier of the automation rule.
RuleId *string
// The revision number of the automation rule.
RuleRevision *int64
// The type of automation rule.
RuleType types.RuleType
// Configuration for scheduling when automation rules should execute, including
// timing and execution windows.
Schedule *types.Schedule
// The current status of the automation rule (Active or Inactive).
Status types.RuleStatus
// The tags associated with the automation rule.
Tags []types.Tag
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type GetEnrollmentConfigurationInput ¶
type GetEnrollmentConfigurationInput struct {
// contains filtered or unexported fields
}
type GetEnrollmentConfigurationOutput ¶
type GetEnrollmentConfigurationOutput struct {
// The current enrollment status.
//
// This member is required.
Status types.EnrollmentStatus
// The timestamp of the last update to the enrollment configuration.
LastUpdatedTimestamp *time.Time
// Specifies whether the management account can create Automation rules that
// implement optimization actions for this account.
OrganizationRuleMode types.OrganizationRuleMode
// The reason for the current enrollment status.
StatusReason *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListAccountsAPIClient ¶
type ListAccountsAPIClient interface {
ListAccounts(context.Context, *ListAccountsInput, ...func(*Options)) (*ListAccountsOutput, error)
}
ListAccountsAPIClient is a client that implements the ListAccounts operation.
type ListAccountsInput ¶
type ListAccountsOutput ¶
type ListAccountsOutput struct {
// The list of accounts in your organization enrolled in Compute Optimizer
//
// This member is required.
Accounts []types.AccountInfo
// The token to use to retrieve the next page of results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListAccountsPaginator ¶
type ListAccountsPaginator struct {
// contains filtered or unexported fields
}
ListAccountsPaginator is a paginator for ListAccounts
func NewListAccountsPaginator ¶
func NewListAccountsPaginator(client ListAccountsAPIClient, params *ListAccountsInput, optFns ...func(*ListAccountsPaginatorOptions)) *ListAccountsPaginator
NewListAccountsPaginator returns a new ListAccountsPaginator
func (*ListAccountsPaginator) HasMorePages ¶
func (p *ListAccountsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAccountsPaginator) NextPage ¶
func (p *ListAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccountsOutput, error)
NextPage retrieves the next ListAccounts page.
type ListAccountsPaginatorOptions ¶
type ListAccountsPaginatorOptions struct {
// The maximum number of results 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
}
ListAccountsPaginatorOptions is the paginator options for ListAccounts
type ListAutomationEventStepsAPIClient ¶
type ListAutomationEventStepsAPIClient interface {
ListAutomationEventSteps(context.Context, *ListAutomationEventStepsInput, ...func(*Options)) (*ListAutomationEventStepsOutput, error)
}
ListAutomationEventStepsAPIClient is a client that implements the ListAutomationEventSteps operation.
type ListAutomationEventStepsInput ¶
type ListAutomationEventStepsInput struct {
// The ID of the automation event.
//
// This member is required.
EventId *string
// The maximum number of automation event steps to return in a single response.
// Valid range is 1-1000.
MaxResults *int32
// A token used for pagination to retrieve the next set of results when the
// response is truncated.
NextToken *string
// contains filtered or unexported fields
}
type ListAutomationEventStepsOutput ¶
type ListAutomationEventStepsOutput struct {
// The list of steps for the specified automation event.
AutomationEventSteps []types.AutomationEventStep
// A token used for pagination. If present, indicates there are more results
// available and can be used in subsequent requests.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListAutomationEventStepsPaginator ¶
type ListAutomationEventStepsPaginator struct {
// contains filtered or unexported fields
}
ListAutomationEventStepsPaginator is a paginator for ListAutomationEventSteps
func NewListAutomationEventStepsPaginator ¶
func NewListAutomationEventStepsPaginator(client ListAutomationEventStepsAPIClient, params *ListAutomationEventStepsInput, optFns ...func(*ListAutomationEventStepsPaginatorOptions)) *ListAutomationEventStepsPaginator
NewListAutomationEventStepsPaginator returns a new ListAutomationEventStepsPaginator
func (*ListAutomationEventStepsPaginator) HasMorePages ¶
func (p *ListAutomationEventStepsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAutomationEventStepsPaginator) NextPage ¶
func (p *ListAutomationEventStepsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAutomationEventStepsOutput, error)
NextPage retrieves the next ListAutomationEventSteps page.
type ListAutomationEventStepsPaginatorOptions ¶
type ListAutomationEventStepsPaginatorOptions struct {
// The maximum number of automation event steps to return in a single response.
// Valid range is 1-1000.
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
}
ListAutomationEventStepsPaginatorOptions is the paginator options for ListAutomationEventSteps
type ListAutomationEventSummariesAPIClient ¶
type ListAutomationEventSummariesAPIClient interface {
ListAutomationEventSummaries(context.Context, *ListAutomationEventSummariesInput, ...func(*Options)) (*ListAutomationEventSummariesOutput, error)
}
ListAutomationEventSummariesAPIClient is a client that implements the ListAutomationEventSummaries operation.
type ListAutomationEventSummariesInput ¶
type ListAutomationEventSummariesInput struct {
// The end date for filtering automation event summaries, exclusive. Events
// created before this date will be included.
EndDateExclusive *string
// The filters to apply to the list of automation event summaries.
Filters []types.AutomationEventFilter
// The maximum number of automation event summaries to return in a single
// response. Valid range is 1-1000.
MaxResults *int32
// A token used for pagination to retrieve the next set of results when the
// response is truncated.
NextToken *string
// The start date for filtering automation event summaries, inclusive. Events
// created on or after this date will be included.
StartDateInclusive *string
// contains filtered or unexported fields
}
type ListAutomationEventSummariesOutput ¶
type ListAutomationEventSummariesOutput struct {
// The list of automation event summaries that match the specified criteria.
AutomationEventSummaries []types.AutomationEventSummary
// A token used for pagination. If present, indicates there are more results
// available and can be used in subsequent requests.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListAutomationEventSummariesPaginator ¶
type ListAutomationEventSummariesPaginator struct {
// contains filtered or unexported fields
}
ListAutomationEventSummariesPaginator is a paginator for ListAutomationEventSummaries
func NewListAutomationEventSummariesPaginator ¶
func NewListAutomationEventSummariesPaginator(client ListAutomationEventSummariesAPIClient, params *ListAutomationEventSummariesInput, optFns ...func(*ListAutomationEventSummariesPaginatorOptions)) *ListAutomationEventSummariesPaginator
NewListAutomationEventSummariesPaginator returns a new ListAutomationEventSummariesPaginator
func (*ListAutomationEventSummariesPaginator) HasMorePages ¶
func (p *ListAutomationEventSummariesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAutomationEventSummariesPaginator) NextPage ¶
func (p *ListAutomationEventSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAutomationEventSummariesOutput, error)
NextPage retrieves the next ListAutomationEventSummaries page.
type ListAutomationEventSummariesPaginatorOptions ¶
type ListAutomationEventSummariesPaginatorOptions struct {
// The maximum number of automation event summaries to return in a single
// response. Valid range is 1-1000.
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
}
ListAutomationEventSummariesPaginatorOptions is the paginator options for ListAutomationEventSummaries
type ListAutomationEventsAPIClient ¶
type ListAutomationEventsAPIClient interface {
ListAutomationEvents(context.Context, *ListAutomationEventsInput, ...func(*Options)) (*ListAutomationEventsOutput, error)
}
ListAutomationEventsAPIClient is a client that implements the ListAutomationEvents operation.
type ListAutomationEventsInput ¶
type ListAutomationEventsInput struct {
// The end of the time range to query for events.
EndTimeExclusive *time.Time
// The filters to apply to the list of automation events.
Filters []types.AutomationEventFilter
// The maximum number of results to return in a single call.
MaxResults *int32
// The token for the next page of results.
NextToken *string
// The start of the time range to query for events.
StartTimeInclusive *time.Time
// contains filtered or unexported fields
}
type ListAutomationEventsOutput ¶
type ListAutomationEventsOutput struct {
// The list of automation events that match the specified criteria.
AutomationEvents []types.AutomationEvent
// The token to use to retrieve the next page of results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListAutomationEventsPaginator ¶
type ListAutomationEventsPaginator struct {
// contains filtered or unexported fields
}
ListAutomationEventsPaginator is a paginator for ListAutomationEvents
func NewListAutomationEventsPaginator ¶
func NewListAutomationEventsPaginator(client ListAutomationEventsAPIClient, params *ListAutomationEventsInput, optFns ...func(*ListAutomationEventsPaginatorOptions)) *ListAutomationEventsPaginator
NewListAutomationEventsPaginator returns a new ListAutomationEventsPaginator
func (*ListAutomationEventsPaginator) HasMorePages ¶
func (p *ListAutomationEventsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAutomationEventsPaginator) NextPage ¶
func (p *ListAutomationEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAutomationEventsOutput, error)
NextPage retrieves the next ListAutomationEvents page.
type ListAutomationEventsPaginatorOptions ¶
type ListAutomationEventsPaginatorOptions struct {
// The maximum number of results 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
}
ListAutomationEventsPaginatorOptions is the paginator options for ListAutomationEvents
type ListAutomationRulePreviewAPIClient ¶
type ListAutomationRulePreviewAPIClient interface {
ListAutomationRulePreview(context.Context, *ListAutomationRulePreviewInput, ...func(*Options)) (*ListAutomationRulePreviewOutput, error)
}
ListAutomationRulePreviewAPIClient is a client that implements the ListAutomationRulePreview operation.
type ListAutomationRulePreviewInput ¶
type ListAutomationRulePreviewInput struct {
// The types of recommended actions to include in the preview.
//
// This member is required.
RecommendedActionTypes []types.RecommendedActionType
// The type of rule.
//
// Only the management account or a delegated administrator can set the ruleType
// to be OrganizationRule.
//
// This member is required.
RuleType types.RuleType
// A set of conditions that specify which recommended action qualify for
// implementation. When a rule is active and a recommended action matches these
// criteria, Compute Optimizer implements the action at the scheduled run time.
Criteria *types.Criteria
// The maximum number of automation rule preview results to return in a single
// response. Valid range is 1-1000.
MaxResults *int32
// A token used for pagination to retrieve the next set of results when the
// response is truncated.
NextToken *string
// The organizational scope for the rule preview.
OrganizationScope *types.OrganizationScope
// contains filtered or unexported fields
}
type ListAutomationRulePreviewOutput ¶
type ListAutomationRulePreviewOutput struct {
// A token used for pagination. If present, indicates there are more results
// available and can be used in subsequent requests.
NextToken *string
// The list of actions that would be taken based on the specified criteria.
PreviewResults []types.PreviewResult
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListAutomationRulePreviewPaginator ¶
type ListAutomationRulePreviewPaginator struct {
// contains filtered or unexported fields
}
ListAutomationRulePreviewPaginator is a paginator for ListAutomationRulePreview
func NewListAutomationRulePreviewPaginator ¶
func NewListAutomationRulePreviewPaginator(client ListAutomationRulePreviewAPIClient, params *ListAutomationRulePreviewInput, optFns ...func(*ListAutomationRulePreviewPaginatorOptions)) *ListAutomationRulePreviewPaginator
NewListAutomationRulePreviewPaginator returns a new ListAutomationRulePreviewPaginator
func (*ListAutomationRulePreviewPaginator) HasMorePages ¶
func (p *ListAutomationRulePreviewPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAutomationRulePreviewPaginator) NextPage ¶
func (p *ListAutomationRulePreviewPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAutomationRulePreviewOutput, error)
NextPage retrieves the next ListAutomationRulePreview page.
type ListAutomationRulePreviewPaginatorOptions ¶
type ListAutomationRulePreviewPaginatorOptions struct {
// The maximum number of automation rule preview results to return in a single
// response. Valid range is 1-1000.
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
}
ListAutomationRulePreviewPaginatorOptions is the paginator options for ListAutomationRulePreview
type ListAutomationRulePreviewSummariesAPIClient ¶
type ListAutomationRulePreviewSummariesAPIClient interface {
ListAutomationRulePreviewSummaries(context.Context, *ListAutomationRulePreviewSummariesInput, ...func(*Options)) (*ListAutomationRulePreviewSummariesOutput, error)
}
ListAutomationRulePreviewSummariesAPIClient is a client that implements the ListAutomationRulePreviewSummaries operation.
type ListAutomationRulePreviewSummariesInput ¶
type ListAutomationRulePreviewSummariesInput struct {
// The types of recommended actions to include in the preview.
//
// This member is required.
RecommendedActionTypes []types.RecommendedActionType
// The type of rule.
//
// This member is required.
RuleType types.RuleType
// A set of conditions that specify which recommended action qualify for
// implementation. When a rule is active and a recommended action matches these
// criteria, Compute Optimizer implements the action at the scheduled run time. You
// can specify up to 20 conditions per filter criteria and 20 values per condition.
Criteria *types.Criteria
// The maximum number of automation rule preview summaries to return in a single
// response. Valid range is 1-1000.
MaxResults *int32
// A token used for pagination to retrieve the next set of results when the
// response is truncated.
NextToken *string
// The organizational scope for the rule preview.
OrganizationScope *types.OrganizationScope
// contains filtered or unexported fields
}
type ListAutomationRulePreviewSummariesOutput ¶
type ListAutomationRulePreviewSummariesOutput struct {
// A token used for pagination. If present, indicates there are more results
// available and can be used in subsequent requests.
NextToken *string
// The list of automation rule preview summaries that match the specified criteria.
PreviewResultSummaries []types.PreviewResultSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListAutomationRulePreviewSummariesPaginator ¶
type ListAutomationRulePreviewSummariesPaginator struct {
// contains filtered or unexported fields
}
ListAutomationRulePreviewSummariesPaginator is a paginator for ListAutomationRulePreviewSummaries
func NewListAutomationRulePreviewSummariesPaginator ¶
func NewListAutomationRulePreviewSummariesPaginator(client ListAutomationRulePreviewSummariesAPIClient, params *ListAutomationRulePreviewSummariesInput, optFns ...func(*ListAutomationRulePreviewSummariesPaginatorOptions)) *ListAutomationRulePreviewSummariesPaginator
NewListAutomationRulePreviewSummariesPaginator returns a new ListAutomationRulePreviewSummariesPaginator
func (*ListAutomationRulePreviewSummariesPaginator) HasMorePages ¶
func (p *ListAutomationRulePreviewSummariesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAutomationRulePreviewSummariesPaginator) NextPage ¶
func (p *ListAutomationRulePreviewSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAutomationRulePreviewSummariesOutput, error)
NextPage retrieves the next ListAutomationRulePreviewSummaries page.
type ListAutomationRulePreviewSummariesPaginatorOptions ¶
type ListAutomationRulePreviewSummariesPaginatorOptions struct {
// The maximum number of automation rule preview summaries to return in a single
// response. Valid range is 1-1000.
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
}
ListAutomationRulePreviewSummariesPaginatorOptions is the paginator options for ListAutomationRulePreviewSummaries
type ListAutomationRulesAPIClient ¶
type ListAutomationRulesAPIClient interface {
ListAutomationRules(context.Context, *ListAutomationRulesInput, ...func(*Options)) (*ListAutomationRulesOutput, error)
}
ListAutomationRulesAPIClient is a client that implements the ListAutomationRules operation.
type ListAutomationRulesInput ¶
type ListAutomationRulesInput struct {
// The filters to apply to the list of automation rules.
Filters []types.Filter
// The maximum number of automation rules to return in a single response. Valid
// range is 1-1000.
MaxResults *int32
// A token used for pagination to retrieve the next set of results when the
// response is truncated.
NextToken *string
// contains filtered or unexported fields
}
type ListAutomationRulesOutput ¶
type ListAutomationRulesOutput struct {
// The list of automation rules that match the specified criteria.
AutomationRules []types.AutomationRule
// A token used for pagination. If present, indicates there are more results
// available and can be used in subsequent requests.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListAutomationRulesPaginator ¶
type ListAutomationRulesPaginator struct {
// contains filtered or unexported fields
}
ListAutomationRulesPaginator is a paginator for ListAutomationRules
func NewListAutomationRulesPaginator ¶
func NewListAutomationRulesPaginator(client ListAutomationRulesAPIClient, params *ListAutomationRulesInput, optFns ...func(*ListAutomationRulesPaginatorOptions)) *ListAutomationRulesPaginator
NewListAutomationRulesPaginator returns a new ListAutomationRulesPaginator
func (*ListAutomationRulesPaginator) HasMorePages ¶
func (p *ListAutomationRulesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAutomationRulesPaginator) NextPage ¶
func (p *ListAutomationRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAutomationRulesOutput, error)
NextPage retrieves the next ListAutomationRules page.
type ListAutomationRulesPaginatorOptions ¶
type ListAutomationRulesPaginatorOptions struct {
// The maximum number of automation rules to return in a single response. Valid
// range is 1-1000.
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
}
ListAutomationRulesPaginatorOptions is the paginator options for ListAutomationRules
type ListRecommendedActionSummariesAPIClient ¶
type ListRecommendedActionSummariesAPIClient interface {
ListRecommendedActionSummaries(context.Context, *ListRecommendedActionSummariesInput, ...func(*Options)) (*ListRecommendedActionSummariesOutput, error)
}
ListRecommendedActionSummariesAPIClient is a client that implements the ListRecommendedActionSummaries operation.
type ListRecommendedActionSummariesInput ¶
type ListRecommendedActionSummariesInput struct {
// A list of filters to apply when retrieving recommended action summaries.
// Filters can be based on resource type, action type, account ID, and other
// criteria.
Filters []types.RecommendedActionFilter
// The maximum number of recommended action summaries to return in a single
// response. Valid range is 1-1000.
MaxResults *int32
// A token used for pagination to retrieve the next set of results when the
// response is truncated.
NextToken *string
// contains filtered or unexported fields
}
type ListRecommendedActionSummariesOutput ¶
type ListRecommendedActionSummariesOutput struct {
// A token used for pagination. If present, indicates there are more results
// available and can be used in subsequent requests.
NextToken *string
// The summary of recommended actions that match the specified criteria.
RecommendedActionSummaries []types.RecommendedActionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListRecommendedActionSummariesPaginator ¶
type ListRecommendedActionSummariesPaginator struct {
// contains filtered or unexported fields
}
ListRecommendedActionSummariesPaginator is a paginator for ListRecommendedActionSummaries
func NewListRecommendedActionSummariesPaginator ¶
func NewListRecommendedActionSummariesPaginator(client ListRecommendedActionSummariesAPIClient, params *ListRecommendedActionSummariesInput, optFns ...func(*ListRecommendedActionSummariesPaginatorOptions)) *ListRecommendedActionSummariesPaginator
NewListRecommendedActionSummariesPaginator returns a new ListRecommendedActionSummariesPaginator
func (*ListRecommendedActionSummariesPaginator) HasMorePages ¶
func (p *ListRecommendedActionSummariesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRecommendedActionSummariesPaginator) NextPage ¶
func (p *ListRecommendedActionSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendedActionSummariesOutput, error)
NextPage retrieves the next ListRecommendedActionSummaries page.
type ListRecommendedActionSummariesPaginatorOptions ¶
type ListRecommendedActionSummariesPaginatorOptions struct {
// The maximum number of recommended action summaries to return in a single
// response. Valid range is 1-1000.
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
}
ListRecommendedActionSummariesPaginatorOptions is the paginator options for ListRecommendedActionSummaries
type ListRecommendedActionsAPIClient ¶
type ListRecommendedActionsAPIClient interface {
ListRecommendedActions(context.Context, *ListRecommendedActionsInput, ...func(*Options)) (*ListRecommendedActionsOutput, error)
}
ListRecommendedActionsAPIClient is a client that implements the ListRecommendedActions operation.
type ListRecommendedActionsInput ¶
type ListRecommendedActionsInput struct {
// The filters to apply to the list of recommended actions.
Filters []types.RecommendedActionFilter
// The maximum number of recommended actions to return in a single response. Valid
// range is 1-1000.
MaxResults *int32
// A token used for pagination to retrieve the next set of results when the
// response is truncated.
NextToken *string
// contains filtered or unexported fields
}
type ListRecommendedActionsOutput ¶
type ListRecommendedActionsOutput struct {
// A token used for pagination. If present, indicates there are more results
// available and can be used in subsequent requests.
NextToken *string
// The list of recommended actions that match the specified criteria.
RecommendedActions []types.RecommendedAction
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListRecommendedActionsPaginator ¶
type ListRecommendedActionsPaginator struct {
// contains filtered or unexported fields
}
ListRecommendedActionsPaginator is a paginator for ListRecommendedActions
func NewListRecommendedActionsPaginator ¶
func NewListRecommendedActionsPaginator(client ListRecommendedActionsAPIClient, params *ListRecommendedActionsInput, optFns ...func(*ListRecommendedActionsPaginatorOptions)) *ListRecommendedActionsPaginator
NewListRecommendedActionsPaginator returns a new ListRecommendedActionsPaginator
func (*ListRecommendedActionsPaginator) HasMorePages ¶
func (p *ListRecommendedActionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRecommendedActionsPaginator) NextPage ¶
func (p *ListRecommendedActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendedActionsOutput, error)
NextPage retrieves the next ListRecommendedActions page.
type ListRecommendedActionsPaginatorOptions ¶
type ListRecommendedActionsPaginatorOptions struct {
// The maximum number of recommended actions to return in a single response. Valid
// range is 1-1000.
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
}
ListRecommendedActionsPaginatorOptions is the paginator options for ListRecommendedActions
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct {
// The ARN of the resource to list tags for.
//
// This member is required.
ResourceArn *string
// contains filtered or unexported fields
}
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct {
// The list of tags associated with the specified resource.
Tags []types.Tag
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
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
// Provides idempotency tokens values that will be automatically populated into
// idempotent API operations.
IdempotencyTokenProvider IdempotencyTokenProvider
// 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) 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 RollbackAutomationEventInput ¶
type RollbackAutomationEventInput struct {
// The ID of the automation event to roll back.
//
// This member is required.
EventId *string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. Must be 1-64 characters long and contain only alphanumeric
// characters, underscores, and hyphens.
ClientToken *string
// contains filtered or unexported fields
}
type RollbackAutomationEventOutput ¶
type RollbackAutomationEventOutput struct {
// The ID of the automation event being rolled back.
EventId *string
// The current status of the rollback operation.
EventStatus types.EventStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type StartAutomationEventInput ¶
type StartAutomationEventInput struct {
// The ID of the recommended action to automate.
//
// This member is required.
RecommendedActionId *string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. Must be 1-64 characters long and contain only alphanumeric
// characters, underscores, and hyphens.
ClientToken *string
// contains filtered or unexported fields
}
type StartAutomationEventOutput ¶
type StartAutomationEventOutput struct {
// The ID of the automation event.
EventId *string
// The current status of the automation event.
EventStatus types.EventStatus
// The ID of the recommended action being automated.
RecommendedActionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type TagResourceInput ¶
type TagResourceInput struct {
// The ARN of the resource to tag.
//
// This member is required.
ResourceArn *string
// The revision number of the automation rule to tag. This ensures you're tagging
// the correct version of the rule.
//
// This member is required.
RuleRevision *int64
// The tags to add to the resource.
//
// This member is required.
Tags []types.Tag
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. Must be 1-64 characters long and contain only alphanumeric
// characters, underscores, and hyphens.
ClientToken *string
// contains filtered or unexported fields
}
type TagResourceOutput ¶
type TagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type UntagResourceInput ¶
type UntagResourceInput struct {
// The ARN of the resource to untag.
//
// This member is required.
ResourceArn *string
// The revision number of the automation rule to untag. This ensures you're
// untagging the correct version of the rule.
//
// This member is required.
RuleRevision *int64
// The keys of the tags to remove from the resource.
//
// This member is required.
TagKeys []string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. Must be 1-64 characters long and contain only alphanumeric
// characters, underscores, and hyphens.
ClientToken *string
// contains filtered or unexported fields
}
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type UpdateAutomationRuleInput ¶
type UpdateAutomationRuleInput struct {
// The ARN of the rule to update.
//
// This member is required.
RuleArn *string
// The revision number of the rule to update.
//
// This member is required.
RuleRevision *int64
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. Must be 1-64 characters long and contain only alphanumeric
// characters, underscores, and hyphens.
ClientToken *string
// A set of conditions that specify which recommended action qualify for
// implementation. When a rule is active and a recommended action matches these
// criteria, Compute Optimizer implements the action at the scheduled run time. You
// can specify up to 20 conditions per filter criteria and 20 values per condition.
Criteria *types.Criteria
// The updated description of the automation rule. Can be up to 1024 characters
// long and contain alphanumeric characters, underscores, hyphens, spaces, and
// certain special characters.
Description *string
// The updated name of the automation rule. Must be 1-128 characters long and
// contain only alphanumeric characters, underscores, and hyphens.
Name *string
// Updated configuration settings for organization-wide rules, including rule
// application order and target account IDs.
OrganizationConfiguration *types.OrganizationConfiguration
// The updated priority level of the automation rule, used to determine execution
// order when multiple rules apply to the same resource.
Priority *string
// Updated list of recommended action types that this rule can execute, such as
// SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.
RecommendedActionTypes []types.RecommendedActionType
// The updated type of automation rule. Can be either OrganizationRule for
// organization-wide rules or AccountRule for account-specific rules.
RuleType types.RuleType
// The updated schedule configuration for when the automation rule should execute,
// including cron expression, timezone, and execution window.
Schedule *types.Schedule
// The updated status of the automation rule. Can be Active or Inactive.
Status types.RuleStatus
// contains filtered or unexported fields
}
type UpdateAutomationRuleOutput ¶
type UpdateAutomationRuleOutput struct {
// The timestamp when the automation rule was originally created.
CreatedTimestamp *time.Time
// A set of conditions that specify which recommended action qualify for
// implementation. When a rule is active and a recommended action matches these
// criteria, Compute Optimizer implements the action at the scheduled run time. You
// can specify up to 20 conditions per filter criteria and 20 values per condition.
Criteria *types.Criteria
// The updated description of the automation rule.
Description *string
// The timestamp when the automation rule was last updated.
LastUpdatedTimestamp *time.Time
// The updated name of the automation rule.
Name *string
// The updated organization configuration settings.
OrganizationConfiguration *types.OrganizationConfiguration
// The updated priority level of the automation rule.
Priority *string
// The updated list of recommended action types.
RecommendedActionTypes []types.RecommendedActionType
// The ARN of the updated rule.
RuleArn *string
// The new revision number of the updated rule.
RuleRevision *int64
// The updated type of automation rule.
RuleType types.RuleType
// The updated schedule configuration.
Schedule *types.Schedule
// The updated status of the automation rule.
Status types.RuleStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type UpdateEnrollmentConfigurationInput ¶
type UpdateEnrollmentConfigurationInput struct {
// The desired enrollment status.
//
// - Active - Enables the Automation feature for your account.
//
// - Inactive - Disables the Automation feature for your account and stops all
// of your automation rules. If you opt in again later, all rules will be inactive,
// and you must enable the rules you want to run. You must wait at least 24 hours
// after opting out to opt in again.
//
// The Pending and Failed options cannot be used to update the enrollment status
// of an account. They are returned in the response of a request to update the
// enrollment status of an account.
//
// If you are a member account, your account must be disassociated from your
// organization’s management account before you can disable Automation. Contact
// your administrator to make this change.
//
// This member is required.
Status types.EnrollmentStatus
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request. Must be 1-64 characters long and contain only alphanumeric
// characters, underscores, and hyphens.
ClientToken *string
// contains filtered or unexported fields
}
type UpdateEnrollmentConfigurationOutput ¶
type UpdateEnrollmentConfigurationOutput struct {
// The timestamp when the enrollment configuration was last updated.
//
// This member is required.
LastUpdatedTimestamp *time.Time
// The updated enrollment status.
//
// This member is required.
Status types.EnrollmentStatus
// The reason for the updated enrollment status.
StatusReason *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Source Files
¶
- api_client.go
- api_op_AssociateAccounts.go
- api_op_CreateAutomationRule.go
- api_op_DeleteAutomationRule.go
- api_op_DisassociateAccounts.go
- api_op_GetAutomationEvent.go
- api_op_GetAutomationRule.go
- api_op_GetEnrollmentConfiguration.go
- api_op_ListAccounts.go
- api_op_ListAutomationEventSteps.go
- api_op_ListAutomationEventSummaries.go
- api_op_ListAutomationEvents.go
- api_op_ListAutomationRulePreview.go
- api_op_ListAutomationRulePreviewSummaries.go
- api_op_ListAutomationRules.go
- api_op_ListRecommendedActionSummaries.go
- api_op_ListRecommendedActions.go
- api_op_ListTagsForResource.go
- api_op_RollbackAutomationEvent.go
- api_op_StartAutomationEvent.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateAutomationRule.go
- api_op_UpdateEnrollmentConfiguration.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go