trustedadvisor

package module
v1.8.13 Latest Latest
Warning

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

 Go to latest Published: Jan 24, 2025 License: Apache-2.0 Imports: 44 Imported by: 6

Documentation

Overview

Package trustedadvisor provides the API client, operations, and parameter types for TrustedAdvisor Public API.

TrustedAdvisor Public API

Index

Constants

View Source 
const ServiceAPIVersion = "2022-09-15"
View Source 
const ServiceID = "TrustedAdvisor"

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 BatchUpdateRecommendationResourceExclusionInput added in v1.4.0 

type BatchUpdateRecommendationResourceExclusionInput struct {

	// A list of recommendation resource ARNs and exclusion status to update
	//
	// This member is required.
	RecommendationResourceExclusions []types.RecommendationResourceExclusion
	// contains filtered or unexported fields
}

type BatchUpdateRecommendationResourceExclusionOutput added in v1.4.0 

type BatchUpdateRecommendationResourceExclusionOutput struct {

	// A list of recommendation resource ARNs whose exclusion status failed to update,
	// if any
	//
	// This member is required.
	BatchUpdateRecommendationResourceExclusionErrors []types.UpdateRecommendationResourceExclusionError

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

type Client 

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

Client provides the API client to make operations call for TrustedAdvisor Public API.

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) BatchUpdateRecommendationResourceExclusion added in v1.4.0 

func (c *Client) BatchUpdateRecommendationResourceExclusion(ctx context.Context, params *BatchUpdateRecommendationResourceExclusionInput, optFns ...func(*Options)) (*BatchUpdateRecommendationResourceExclusionOutput, error)

Update one or more exclusion status for a list of recommendation resources

func (*Client) GetOrganizationRecommendation 

func (c *Client) GetOrganizationRecommendation(ctx context.Context, params *GetOrganizationRecommendationInput, optFns ...func(*Options)) (*GetOrganizationRecommendationOutput, error)

Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations.

func (*Client) GetRecommendation 

func (c *Client) GetRecommendation(ctx context.Context, params *GetRecommendationInput, optFns ...func(*Options)) (*GetRecommendationOutput, error)

Get a specific Recommendation

func (*Client) ListChecks 

func (c *Client) ListChecks(ctx context.Context, params *ListChecksInput, optFns ...func(*Options)) (*ListChecksOutput, error)

List a filterable set of Checks

func (*Client) ListOrganizationRecommendationAccounts 

func (c *Client) ListOrganizationRecommendationAccounts(ctx context.Context, params *ListOrganizationRecommendationAccountsInput, optFns ...func(*Options)) (*ListOrganizationRecommendationAccountsOutput, error)

Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations.

func (*Client) ListOrganizationRecommendationResources 

func (c *Client) ListOrganizationRecommendationResources(ctx context.Context, params *ListOrganizationRecommendationResourcesInput, optFns ...func(*Options)) (*ListOrganizationRecommendationResourcesOutput, error)

List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations.

func (*Client) ListOrganizationRecommendations 

func (c *Client) ListOrganizationRecommendations(ctx context.Context, params *ListOrganizationRecommendationsInput, optFns ...func(*Options)) (*ListOrganizationRecommendationsOutput, error)

List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations.

func (*Client) ListRecommendationResources 

func (c *Client) ListRecommendationResources(ctx context.Context, params *ListRecommendationResourcesInput, optFns ...func(*Options)) (*ListRecommendationResourcesOutput, error)

List Resources of a Recommendation

func (*Client) ListRecommendations 

func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, optFns ...func(*Options)) (*ListRecommendationsOutput, error)

List a filterable set of Recommendations

func (*Client) Options added in v1.1.0 

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) UpdateOrganizationRecommendationLifecycle 

func (c *Client) UpdateOrganizationRecommendationLifecycle(ctx context.Context, params *UpdateOrganizationRecommendationLifecycleInput, optFns ...func(*Options)) (*UpdateOrganizationRecommendationLifecycleOutput, error)

Update the lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations.

func (*Client) UpdateRecommendationLifecycle 

func (c *Client) UpdateRecommendationLifecycle(ctx context.Context, params *UpdateRecommendationLifecycleInput, optFns ...func(*Options)) (*UpdateRecommendationLifecycleOutput, error)

Update the lifecyle of a Recommendation. This API only supports prioritized recommendations.

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 GetOrganizationRecommendationInput 

type GetOrganizationRecommendationInput struct {

	// The Recommendation identifier
	//
	// This member is required.
	OrganizationRecommendationIdentifier *string
	// contains filtered or unexported fields
}

type GetOrganizationRecommendationOutput 

type GetOrganizationRecommendationOutput struct {

	// The Recommendation
	OrganizationRecommendation *types.OrganizationRecommendation

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

type GetRecommendationInput 

type GetRecommendationInput struct {

	// The Recommendation identifier
	//
	// This member is required.
	RecommendationIdentifier *string
	// contains filtered or unexported fields
}

type GetRecommendationOutput 

type GetRecommendationOutput struct {

	// The Recommendation
	Recommendation *types.Recommendation

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

type ListChecksAPIClient interface {
	ListChecks(context.Context, *ListChecksInput, ...func(*Options)) (*ListChecksOutput, error)
}

ListChecksAPIClient is a client that implements the ListChecks operation.

type ListChecksInput 

type ListChecksInput struct {

	// The aws service associated with the check
	AwsService *string

	// The ISO 639-1 code for the language that you want your checks to appear in.
	Language types.RecommendationLanguage

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The pillar of the check
	Pillar types.RecommendationPillar

	// The source of the check
	Source types.RecommendationSource
	// contains filtered or unexported fields
}

type ListChecksOutput 

type ListChecksOutput struct {

	// The list of Checks
	//
	// This member is required.
	CheckSummaries []types.CheckSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListChecksPaginator 

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

ListChecksPaginator is a paginator for ListChecks

func NewListChecksPaginator 

func NewListChecksPaginator(client ListChecksAPIClient, params *ListChecksInput, optFns ...func(*ListChecksPaginatorOptions)) *ListChecksPaginator

NewListChecksPaginator returns a new ListChecksPaginator

func (*ListChecksPaginator) HasMorePages 

func (p *ListChecksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChecksPaginator) NextPage 

func (p *ListChecksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChecksOutput, error)

NextPage retrieves the next ListChecks page.

type ListChecksPaginatorOptions 

type ListChecksPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListChecksPaginatorOptions is the paginator options for ListChecks

type ListOrganizationRecommendationAccountsAPIClient 

type ListOrganizationRecommendationAccountsAPIClient interface {
	ListOrganizationRecommendationAccounts(context.Context, *ListOrganizationRecommendationAccountsInput, ...func(*Options)) (*ListOrganizationRecommendationAccountsOutput, error)
}

ListOrganizationRecommendationAccountsAPIClient is a client that implements the ListOrganizationRecommendationAccounts operation.

type ListOrganizationRecommendationAccountsInput 

type ListOrganizationRecommendationAccountsInput struct {

	// The Recommendation identifier
	//
	// This member is required.
	OrganizationRecommendationIdentifier *string

	// An account affected by this organization recommendation
	AffectedAccountId *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListOrganizationRecommendationAccountsOutput 

type ListOrganizationRecommendationAccountsOutput struct {

	// The account recommendations lifecycles that are applicable to the Recommendation
	//
	// This member is required.
	AccountRecommendationLifecycleSummaries []types.AccountRecommendationLifecycleSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListOrganizationRecommendationAccountsPaginator 

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

ListOrganizationRecommendationAccountsPaginator is a paginator for ListOrganizationRecommendationAccounts

func NewListOrganizationRecommendationAccountsPaginator 

func NewListOrganizationRecommendationAccountsPaginator(client ListOrganizationRecommendationAccountsAPIClient, params *ListOrganizationRecommendationAccountsInput, optFns ...func(*ListOrganizationRecommendationAccountsPaginatorOptions)) *ListOrganizationRecommendationAccountsPaginator

NewListOrganizationRecommendationAccountsPaginator returns a new ListOrganizationRecommendationAccountsPaginator

func (*ListOrganizationRecommendationAccountsPaginator) HasMorePages 

func (p *ListOrganizationRecommendationAccountsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOrganizationRecommendationAccountsPaginator) NextPage 

func (p *ListOrganizationRecommendationAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrganizationRecommendationAccountsOutput, error)

NextPage retrieves the next ListOrganizationRecommendationAccounts page.

type ListOrganizationRecommendationAccountsPaginatorOptions 

type ListOrganizationRecommendationAccountsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListOrganizationRecommendationAccountsPaginatorOptions is the paginator options for ListOrganizationRecommendationAccounts

type ListOrganizationRecommendationResourcesAPIClient 

type ListOrganizationRecommendationResourcesAPIClient interface {
	ListOrganizationRecommendationResources(context.Context, *ListOrganizationRecommendationResourcesInput, ...func(*Options)) (*ListOrganizationRecommendationResourcesOutput, error)
}

ListOrganizationRecommendationResourcesAPIClient is a client that implements the ListOrganizationRecommendationResources operation.

type ListOrganizationRecommendationResourcesInput 

type ListOrganizationRecommendationResourcesInput struct {

	// The AWS Organization organization's Recommendation identifier
	//
	// This member is required.
	OrganizationRecommendationIdentifier *string

	// An account affected by this organization recommendation
	AffectedAccountId *string

	// The exclusion status of the resource
	ExclusionStatus types.ExclusionStatus

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The AWS Region code of the resource
	RegionCode *string

	// The status of the resource
	Status types.ResourceStatus
	// contains filtered or unexported fields
}

type ListOrganizationRecommendationResourcesOutput 

type ListOrganizationRecommendationResourcesOutput struct {

	// A list of Recommendation Resources
	//
	// This member is required.
	OrganizationRecommendationResourceSummaries []types.OrganizationRecommendationResourceSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListOrganizationRecommendationResourcesPaginator 

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

ListOrganizationRecommendationResourcesPaginator is a paginator for ListOrganizationRecommendationResources

func NewListOrganizationRecommendationResourcesPaginator 

func NewListOrganizationRecommendationResourcesPaginator(client ListOrganizationRecommendationResourcesAPIClient, params *ListOrganizationRecommendationResourcesInput, optFns ...func(*ListOrganizationRecommendationResourcesPaginatorOptions)) *ListOrganizationRecommendationResourcesPaginator

NewListOrganizationRecommendationResourcesPaginator returns a new ListOrganizationRecommendationResourcesPaginator

func (*ListOrganizationRecommendationResourcesPaginator) HasMorePages 

func (p *ListOrganizationRecommendationResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOrganizationRecommendationResourcesPaginator) NextPage 

func (p *ListOrganizationRecommendationResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrganizationRecommendationResourcesOutput, error)

NextPage retrieves the next ListOrganizationRecommendationResources page.

type ListOrganizationRecommendationResourcesPaginatorOptions 

type ListOrganizationRecommendationResourcesPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListOrganizationRecommendationResourcesPaginatorOptions is the paginator options for ListOrganizationRecommendationResources

type ListOrganizationRecommendationsAPIClient 

type ListOrganizationRecommendationsAPIClient interface {
	ListOrganizationRecommendations(context.Context, *ListOrganizationRecommendationsInput, ...func(*Options)) (*ListOrganizationRecommendationsOutput, error)
}

ListOrganizationRecommendationsAPIClient is a client that implements the ListOrganizationRecommendations operation.

type ListOrganizationRecommendationsInput 

type ListOrganizationRecommendationsInput struct {

	// After the last update of the Recommendation
	AfterLastUpdatedAt *time.Time

	// The aws service associated with the Recommendation
	AwsService *string

	// Before the last update of the Recommendation
	BeforeLastUpdatedAt *time.Time

	// The check identifier of the Recommendation
	CheckIdentifier *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The pillar of the Recommendation
	Pillar types.RecommendationPillar

	// The source of the Recommendation
	Source types.RecommendationSource

	// The status of the Recommendation
	Status types.RecommendationStatus

	// The type of the Recommendation
	Type types.RecommendationType
	// contains filtered or unexported fields
}

type ListOrganizationRecommendationsOutput 

type ListOrganizationRecommendationsOutput struct {

	// The list of Recommendations
	//
	// This member is required.
	OrganizationRecommendationSummaries []types.OrganizationRecommendationSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListOrganizationRecommendationsPaginator 

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

ListOrganizationRecommendationsPaginator is a paginator for ListOrganizationRecommendations

func NewListOrganizationRecommendationsPaginator 

func NewListOrganizationRecommendationsPaginator(client ListOrganizationRecommendationsAPIClient, params *ListOrganizationRecommendationsInput, optFns ...func(*ListOrganizationRecommendationsPaginatorOptions)) *ListOrganizationRecommendationsPaginator

NewListOrganizationRecommendationsPaginator returns a new ListOrganizationRecommendationsPaginator

func (*ListOrganizationRecommendationsPaginator) HasMorePages 

func (p *ListOrganizationRecommendationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOrganizationRecommendationsPaginator) NextPage 

func (p *ListOrganizationRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrganizationRecommendationsOutput, error)

NextPage retrieves the next ListOrganizationRecommendations page.

type ListOrganizationRecommendationsPaginatorOptions 

type ListOrganizationRecommendationsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListOrganizationRecommendationsPaginatorOptions is the paginator options for ListOrganizationRecommendations

type ListRecommendationResourcesAPIClient 

type ListRecommendationResourcesAPIClient interface {
	ListRecommendationResources(context.Context, *ListRecommendationResourcesInput, ...func(*Options)) (*ListRecommendationResourcesOutput, error)
}

ListRecommendationResourcesAPIClient is a client that implements the ListRecommendationResources operation.

type ListRecommendationResourcesInput 

type ListRecommendationResourcesInput struct {

	// The Recommendation identifier
	//
	// This member is required.
	RecommendationIdentifier *string

	// The exclusion status of the resource
	ExclusionStatus types.ExclusionStatus

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The AWS Region code of the resource
	RegionCode *string

	// The status of the resource
	Status types.ResourceStatus
	// contains filtered or unexported fields
}

type ListRecommendationResourcesOutput 

type ListRecommendationResourcesOutput struct {

	// A list of Recommendation Resources
	//
	// This member is required.
	RecommendationResourceSummaries []types.RecommendationResourceSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListRecommendationResourcesPaginator 

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

ListRecommendationResourcesPaginator is a paginator for ListRecommendationResources

func NewListRecommendationResourcesPaginator 

func NewListRecommendationResourcesPaginator(client ListRecommendationResourcesAPIClient, params *ListRecommendationResourcesInput, optFns ...func(*ListRecommendationResourcesPaginatorOptions)) *ListRecommendationResourcesPaginator

NewListRecommendationResourcesPaginator returns a new ListRecommendationResourcesPaginator

func (*ListRecommendationResourcesPaginator) HasMorePages 

func (p *ListRecommendationResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecommendationResourcesPaginator) NextPage 

func (p *ListRecommendationResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendationResourcesOutput, error)

NextPage retrieves the next ListRecommendationResources page.

type ListRecommendationResourcesPaginatorOptions 

type ListRecommendationResourcesPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListRecommendationResourcesPaginatorOptions is the paginator options for ListRecommendationResources

type ListRecommendationsAPIClient 

type ListRecommendationsAPIClient interface {
	ListRecommendations(context.Context, *ListRecommendationsInput, ...func(*Options)) (*ListRecommendationsOutput, error)
}

ListRecommendationsAPIClient is a client that implements the ListRecommendations operation.

type ListRecommendationsInput 

type ListRecommendationsInput struct {

	// After the last update of the Recommendation
	AfterLastUpdatedAt *time.Time

	// The aws service associated with the Recommendation
	AwsService *string

	// Before the last update of the Recommendation
	BeforeLastUpdatedAt *time.Time

	// The check identifier of the Recommendation
	CheckIdentifier *string

	// The maximum number of results to return per page.
	MaxResults *int32

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

	// The pillar of the Recommendation
	Pillar types.RecommendationPillar

	// The source of the Recommendation
	Source types.RecommendationSource

	// The status of the Recommendation
	Status types.RecommendationStatus

	// The type of the Recommendation
	Type types.RecommendationType
	// contains filtered or unexported fields
}

type ListRecommendationsOutput 

type ListRecommendationsOutput struct {

	// The list of Recommendations
	//
	// This member is required.
	RecommendationSummaries []types.RecommendationSummary

	// The token for the next set of results. Use the value returned in the previous
	// response in the next request to retrieve the next set of results.
	NextToken *string

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

type ListRecommendationsPaginator 

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

ListRecommendationsPaginator is a paginator for ListRecommendations

func NewListRecommendationsPaginator 

func NewListRecommendationsPaginator(client ListRecommendationsAPIClient, params *ListRecommendationsInput, optFns ...func(*ListRecommendationsPaginatorOptions)) *ListRecommendationsPaginator

NewListRecommendationsPaginator returns a new ListRecommendationsPaginator

func (*ListRecommendationsPaginator) HasMorePages 

func (p *ListRecommendationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecommendationsPaginator) NextPage 

func (p *ListRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendationsOutput, error)

NextPage retrieves the next ListRecommendations page.

type ListRecommendationsPaginatorOptions 

type ListRecommendationsPaginatorOptions struct {
	// The maximum number of results to return per page.
	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
}

ListRecommendationsPaginatorOptions is the paginator options for ListRecommendations

type Options 

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

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

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

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

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

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

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

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

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

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

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

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

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

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

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

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

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver 

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

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

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type UpdateOrganizationRecommendationLifecycleInput 

type UpdateOrganizationRecommendationLifecycleInput struct {

	// The new lifecycle stage
	//
	// This member is required.
	LifecycleStage types.UpdateRecommendationLifecycleStage

	// The Recommendation identifier for AWS Trusted Advisor Priority recommendations
	//
	// This member is required.
	OrganizationRecommendationIdentifier *string

	// Reason for the lifecycle stage change
	UpdateReason *string

	// Reason code for the lifecycle state change
	UpdateReasonCode types.UpdateRecommendationLifecycleStageReasonCode
	// contains filtered or unexported fields
}

type UpdateOrganizationRecommendationLifecycleOutput 

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

type UpdateRecommendationLifecycleInput 

type UpdateRecommendationLifecycleInput struct {

	// The new lifecycle stage
	//
	// This member is required.
	LifecycleStage types.UpdateRecommendationLifecycleStage

	// The Recommendation identifier for AWS Trusted Advisor Priority recommendations
	//
	// This member is required.
	RecommendationIdentifier *string

	// Reason for the lifecycle stage change
	UpdateReason *string

	// Reason code for the lifecycle state change
	UpdateReasonCode types.UpdateRecommendationLifecycleStageReasonCode
	// contains filtered or unexported fields
}

type UpdateRecommendationLifecycleOutput 

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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