migrationhubstrategy

package module
v1.17.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 38 Imported by: 2

Documentation

Overview

Package migrationhubstrategy provides the API client, operations, and parameter types for Migration Hub Strategy Recommendations.

Migration Hub Strategy Recommendations This API reference provides descriptions, syntax, and other details about each of the actions and data types for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see AWS SDKs (http://aws.amazon.com/tools/#SDKs) .

Index

Constants

View Source 
const ServiceAPIVersion = "2020-02-19"
View Source 
const ServiceID = "MigrationHubStrategy"

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.14.2 

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

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

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

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 Migration Hub Strategy Recommendations.

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

func (c *Client) GetApplicationComponentDetails(ctx context.Context, params *GetApplicationComponentDetailsInput, optFns ...func(*Options)) (*GetApplicationComponentDetailsOutput, error)

Retrieves details about an application component.

func (*Client) GetApplicationComponentStrategies 

func (c *Client) GetApplicationComponentStrategies(ctx context.Context, params *GetApplicationComponentStrategiesInput, optFns ...func(*Options)) (*GetApplicationComponentStrategiesOutput, error)

Retrieves a list of all the recommended strategies and tools for an application component running on a server.

func (*Client) GetAssessment 

func (c *Client) GetAssessment(ctx context.Context, params *GetAssessmentInput, optFns ...func(*Options)) (*GetAssessmentOutput, error)

Retrieves the status of an on-going assessment.

func (*Client) GetImportFileTask 

func (c *Client) GetImportFileTask(ctx context.Context, params *GetImportFileTaskInput, optFns ...func(*Options)) (*GetImportFileTaskOutput, error)

Retrieves the details about a specific import task.

func (*Client) GetLatestAssessmentId added in v1.6.0 

func (c *Client) GetLatestAssessmentId(ctx context.Context, params *GetLatestAssessmentIdInput, optFns ...func(*Options)) (*GetLatestAssessmentIdOutput, error)

Retrieve the latest ID of a specific assessment task.

func (*Client) GetPortfolioPreferences 

func (c *Client) GetPortfolioPreferences(ctx context.Context, params *GetPortfolioPreferencesInput, optFns ...func(*Options)) (*GetPortfolioPreferencesOutput, error)

Retrieves your migration and modernization preferences.

func (*Client) GetPortfolioSummary 

func (c *Client) GetPortfolioSummary(ctx context.Context, params *GetPortfolioSummaryInput, optFns ...func(*Options)) (*GetPortfolioSummaryOutput, error)

Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.

func (*Client) GetRecommendationReportDetails 

func (c *Client) GetRecommendationReportDetails(ctx context.Context, params *GetRecommendationReportDetailsInput, optFns ...func(*Options)) (*GetRecommendationReportDetailsOutput, error)

Retrieves detailed information about the specified recommendation report.

func (*Client) GetServerDetails 

func (c *Client) GetServerDetails(ctx context.Context, params *GetServerDetailsInput, optFns ...func(*Options)) (*GetServerDetailsOutput, error)

Retrieves detailed information about a specified server.

func (*Client) GetServerStrategies 

func (c *Client) GetServerStrategies(ctx context.Context, params *GetServerStrategiesInput, optFns ...func(*Options)) (*GetServerStrategiesOutput, error)

Retrieves recommended strategies and tools for the specified server.

func (*Client) ListAnalyzableServers added in v1.12.0 

func (c *Client) ListAnalyzableServers(ctx context.Context, params *ListAnalyzableServersInput, optFns ...func(*Options)) (*ListAnalyzableServersOutput, error)

Retrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.

func (*Client) ListApplicationComponents 

func (c *Client) ListApplicationComponents(ctx context.Context, params *ListApplicationComponentsInput, optFns ...func(*Options)) (*ListApplicationComponentsOutput, error)

Retrieves a list of all the application components (processes).

func (*Client) ListCollectors 

func (c *Client) ListCollectors(ctx context.Context, params *ListCollectorsInput, optFns ...func(*Options)) (*ListCollectorsOutput, error)

Retrieves a list of all the installed collectors.

func (*Client) ListImportFileTask 

func (c *Client) ListImportFileTask(ctx context.Context, params *ListImportFileTaskInput, optFns ...func(*Options)) (*ListImportFileTaskOutput, error)

Retrieves a list of all the imports performed.

func (*Client) ListServers 

func (c *Client) ListServers(ctx context.Context, params *ListServersInput, optFns ...func(*Options)) (*ListServersOutput, error)

Returns a list of all the servers.

func (*Client) Options added in v1.15.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) PutPortfolioPreferences 

func (c *Client) PutPortfolioPreferences(ctx context.Context, params *PutPortfolioPreferencesInput, optFns ...func(*Options)) (*PutPortfolioPreferencesOutput, error)

Saves the specified migration and modernization preferences.

func (*Client) StartAssessment 

func (c *Client) StartAssessment(ctx context.Context, params *StartAssessmentInput, optFns ...func(*Options)) (*StartAssessmentOutput, error)

Starts the assessment of an on-premises environment.

func (*Client) StartImportFileTask 

func (c *Client) StartImportFileTask(ctx context.Context, params *StartImportFileTaskInput, optFns ...func(*Options)) (*StartImportFileTaskOutput, error)

Starts a file import.

func (*Client) StartRecommendationReportGeneration 

func (c *Client) StartRecommendationReportGeneration(ctx context.Context, params *StartRecommendationReportGenerationInput, optFns ...func(*Options)) (*StartRecommendationReportGenerationOutput, error)

Starts generating a recommendation report.

func (*Client) StopAssessment 

func (c *Client) StopAssessment(ctx context.Context, params *StopAssessmentInput, optFns ...func(*Options)) (*StopAssessmentOutput, error)

Stops the assessment of an on-premises environment.

func (*Client) UpdateApplicationComponentConfig 

func (c *Client) UpdateApplicationComponentConfig(ctx context.Context, params *UpdateApplicationComponentConfigInput, optFns ...func(*Options)) (*UpdateApplicationComponentConfigOutput, error)

Updates the configuration of an application component.

func (*Client) UpdateServerConfig 

func (c *Client) UpdateServerConfig(ctx context.Context, params *UpdateServerConfigInput, optFns ...func(*Options)) (*UpdateServerConfigOutput, error)

Updates the configuration of the specified server.

type EndpointParameters added in v1.10.0 

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

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.10.0 

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

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

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetApplicationComponentDetailsInput 

type GetApplicationComponentDetailsInput struct {

	// The ID of the application component. The ID is unique within an AWS account.
	//
	// This member is required.
	ApplicationComponentId *string
	// contains filtered or unexported fields
}

type GetApplicationComponentDetailsOutput 

type GetApplicationComponentDetailsOutput struct {

	// Detailed information about an application component.
	ApplicationComponentDetail *types.ApplicationComponentDetail

	// The associated application group as defined in AWS Application Discovery
	// Service.
	AssociatedApplications []types.AssociatedApplication

	// A list of the IDs of the servers on which the application component is running.
	AssociatedServerIds []string

	// Set to true if the application component belongs to more than one application
	// group.
	MoreApplicationResource *bool

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

type GetApplicationComponentStrategiesInput 

type GetApplicationComponentStrategiesInput struct {

	// The ID of the application component. The ID is unique within an AWS account.
	//
	// This member is required.
	ApplicationComponentId *string
	// contains filtered or unexported fields
}

type GetApplicationComponentStrategiesOutput 

type GetApplicationComponentStrategiesOutput struct {

	// A list of application component strategy recommendations.
	ApplicationComponentStrategies []types.ApplicationComponentStrategy

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

type GetAssessmentInput 

type GetAssessmentInput struct {

	// The assessmentid returned by StartAssessment .
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetAssessmentOutput 

type GetAssessmentOutput struct {

	// List of criteria for assessment.
	AssessmentTargets []types.AssessmentTarget

	// Detailed information about the assessment.
	DataCollectionDetails *types.DataCollectionDetails

	// The ID for the specific assessment task.
	Id *string

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

type GetImportFileTaskInput 

type GetImportFileTaskInput struct {

	// The ID of the import file task. This ID is returned in the response of
	// StartImportFileTask .
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetImportFileTaskOutput 

type GetImportFileTaskOutput struct {

	// The time that the import task completed.
	CompletionTime *time.Time

	// The import file task id returned in the response of StartImportFileTask .
	Id *string

	// The name of the import task given in StartImportFileTask .
	ImportName *string

	// The S3 bucket where import file is located.
	InputS3Bucket *string

	// The Amazon S3 key name of the import file.
	InputS3Key *string

	// The number of records that failed to be imported.
	NumberOfRecordsFailed *int32

	// The number of records successfully imported.
	NumberOfRecordsSuccess *int32

	// Start time of the import task.
	StartTime *time.Time

	// Status of import file task.
	Status types.ImportFileTaskStatus

	// The S3 bucket name for status report of import task.
	StatusReportS3Bucket *string

	// The Amazon S3 key name for status report of import task. The report contains
	// details about whether each record imported successfully or why it did not.
	StatusReportS3Key *string

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

type GetLatestAssessmentIdInput added in v1.6.0 

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

type GetLatestAssessmentIdOutput added in v1.6.0 

type GetLatestAssessmentIdOutput struct {

	// The latest ID for the specific assessment task.
	Id *string

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

type GetPortfolioPreferencesInput 

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

type GetPortfolioPreferencesOutput 

type GetPortfolioPreferencesOutput struct {

	// The classification for application component types.
	ApplicationMode types.ApplicationMode

	// The transformation preferences for non-database applications.
	ApplicationPreferences *types.ApplicationPreferences

	// The transformation preferences for database applications.
	DatabasePreferences *types.DatabasePreferences

	// The rank of business goals based on priority.
	PrioritizeBusinessGoals *types.PrioritizeBusinessGoals

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

type GetPortfolioSummaryInput 

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

type GetPortfolioSummaryOutput 

type GetPortfolioSummaryOutput struct {

	// An assessment summary for the portfolio including the number of servers to
	// rehost and the overall number of anti-patterns.
	AssessmentSummary *types.AssessmentSummary

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

type GetRecommendationReportDetailsInput 

type GetRecommendationReportDetailsInput struct {

	// The recommendation report generation task id returned by
	// StartRecommendationReportGeneration .
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetRecommendationReportDetailsOutput 

type GetRecommendationReportDetailsOutput struct {

	// The ID of the recommendation report generation task. See the response of
	// StartRecommendationReportGeneration .
	Id *string

	// Detailed information about the recommendation report.
	RecommendationReportDetails *types.RecommendationReportDetails

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

type GetServerDetailsAPIClient 

type GetServerDetailsAPIClient interface {
	GetServerDetails(context.Context, *GetServerDetailsInput, ...func(*Options)) (*GetServerDetailsOutput, error)
}

GetServerDetailsAPIClient is a client that implements the GetServerDetails operation.

type GetServerDetailsInput 

type GetServerDetailsInput struct {

	// The ID of the server.
	//
	// This member is required.
	ServerId *string

	// The maximum number of items to include in the response. The maximum value is
	// 100.
	MaxResults *int32

	// The token from a previous call that you use to retrieve the next set of
	// results. For example, if a previous call to this action returned 100 items, but
	// you set maxResults to 10. You'll receive a set of 10 results along with a
	// token. You then use the returned token to retrieve the next set of 10.
	NextToken *string
	// contains filtered or unexported fields
}

type GetServerDetailsOutput 

type GetServerDetailsOutput struct {

	// The associated application group the server belongs to, as defined in AWS
	// Application Discovery Service.
	AssociatedApplications []types.AssociatedApplication

	// The token you use to retrieve the next set of results, or null if there are no
	// more results.
	NextToken *string

	// Detailed information about the server.
	ServerDetail *types.ServerDetail

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

type GetServerDetailsPaginator 

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

GetServerDetailsPaginator is a paginator for GetServerDetails

func NewGetServerDetailsPaginator 

func NewGetServerDetailsPaginator(client GetServerDetailsAPIClient, params *GetServerDetailsInput, optFns ...func(*GetServerDetailsPaginatorOptions)) *GetServerDetailsPaginator

NewGetServerDetailsPaginator returns a new GetServerDetailsPaginator

func (*GetServerDetailsPaginator) HasMorePages 

func (p *GetServerDetailsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetServerDetailsPaginator) NextPage 

func (p *GetServerDetailsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetServerDetailsOutput, error)

NextPage retrieves the next GetServerDetails page.

type GetServerDetailsPaginatorOptions 

type GetServerDetailsPaginatorOptions struct {
	// The maximum number of items to include in the response. The maximum value is
	// 100.
	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
}

GetServerDetailsPaginatorOptions is the paginator options for GetServerDetails

type GetServerStrategiesInput 

type GetServerStrategiesInput struct {

	// The ID of the server.
	//
	// This member is required.
	ServerId *string
	// contains filtered or unexported fields
}

type GetServerStrategiesOutput 

type GetServerStrategiesOutput struct {

	// A list of strategy recommendations for the server.
	ServerStrategies []types.ServerStrategy

	// 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 ListAnalyzableServersAPIClient added in v1.12.0 

type ListAnalyzableServersAPIClient interface {
	ListAnalyzableServers(context.Context, *ListAnalyzableServersInput, ...func(*Options)) (*ListAnalyzableServersOutput, error)
}

ListAnalyzableServersAPIClient is a client that implements the ListAnalyzableServers operation.

type ListAnalyzableServersInput added in v1.12.0 

type ListAnalyzableServersInput struct {

	// The maximum number of items to include in the response. The maximum value is
	// 100.
	MaxResults *int32

	// The token from a previous call that you use to retrieve the next set of
	// results. For example, if a previous call to this action returned 100 items, but
	// you set maxResults to 10. You'll receive a set of 10 results along with a token.
	// You then use the returned token to retrieve the next set of 10.
	NextToken *string

	// Specifies whether to sort by ascending (ASC) or descending (DESC) order.
	Sort types.SortOrder
	// contains filtered or unexported fields
}

Represents input for ListAnalyzableServers operation.

type ListAnalyzableServersOutput added in v1.12.0 

type ListAnalyzableServersOutput struct {

	// The list of analyzable servers with summary information about each server.
	AnalyzableServers []types.AnalyzableServerSummary

	// The token you use to retrieve the next set of results, or null if there are no
	// more results.
	NextToken *string

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

Represents output for ListAnalyzableServers operation.

type ListAnalyzableServersPaginator added in v1.12.0 

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

ListAnalyzableServersPaginator is a paginator for ListAnalyzableServers

func NewListAnalyzableServersPaginator added in v1.12.0 

func NewListAnalyzableServersPaginator(client ListAnalyzableServersAPIClient, params *ListAnalyzableServersInput, optFns ...func(*ListAnalyzableServersPaginatorOptions)) *ListAnalyzableServersPaginator

NewListAnalyzableServersPaginator returns a new ListAnalyzableServersPaginator

func (*ListAnalyzableServersPaginator) HasMorePages added in v1.12.0 

func (p *ListAnalyzableServersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnalyzableServersPaginator) NextPage added in v1.12.0 

func (p *ListAnalyzableServersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAnalyzableServersOutput, error)

NextPage retrieves the next ListAnalyzableServers page.

type ListAnalyzableServersPaginatorOptions added in v1.12.0 

type ListAnalyzableServersPaginatorOptions struct {
	// The maximum number of items to include in the response. The maximum value is
	// 100.
	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
}

ListAnalyzableServersPaginatorOptions is the paginator options for ListAnalyzableServers

type ListApplicationComponentsAPIClient 

type ListApplicationComponentsAPIClient interface {
	ListApplicationComponents(context.Context, *ListApplicationComponentsInput, ...func(*Options)) (*ListApplicationComponentsOutput, error)
}

ListApplicationComponentsAPIClient is a client that implements the ListApplicationComponents operation.

type ListApplicationComponentsInput 

type ListApplicationComponentsInput struct {

	// Criteria for filtering the list of application components.
	ApplicationComponentCriteria types.ApplicationComponentCriteria

	// Specify the value based on the application component criteria type. For
	// example, if applicationComponentCriteria is set to SERVER_ID and filterValue is
	// set to server1 , then ListApplicationComponents returns all the application
	// components running on server1.
	FilterValue *string

	// The group ID specified in to filter on.
	GroupIdFilter []types.Group

	// The maximum number of items to include in the response. The maximum value is
	// 100.
	MaxResults *int32

	// The token from a previous call that you use to retrieve the next set of
	// results. For example, if a previous call to this action returned 100 items, but
	// you set maxResults to 10. You'll receive a set of 10 results along with a
	// token. You then use the returned token to retrieve the next set of 10.
	NextToken *string

	// Specifies whether to sort by ascending ( ASC ) or descending ( DESC ) order.
	Sort types.SortOrder
	// contains filtered or unexported fields
}

type ListApplicationComponentsOutput 

type ListApplicationComponentsOutput struct {

	// The list of application components with detailed information about each
	// component.
	ApplicationComponentInfos []types.ApplicationComponentDetail

	// The token you use to retrieve the next set of results, or null if there are no
	// more results.
	NextToken *string

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

type ListApplicationComponentsPaginator 

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

ListApplicationComponentsPaginator is a paginator for ListApplicationComponents

func NewListApplicationComponentsPaginator 

func NewListApplicationComponentsPaginator(client ListApplicationComponentsAPIClient, params *ListApplicationComponentsInput, optFns ...func(*ListApplicationComponentsPaginatorOptions)) *ListApplicationComponentsPaginator

NewListApplicationComponentsPaginator returns a new ListApplicationComponentsPaginator

func (*ListApplicationComponentsPaginator) HasMorePages 

func (p *ListApplicationComponentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationComponentsPaginator) NextPage 

func (p *ListApplicationComponentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationComponentsOutput, error)

NextPage retrieves the next ListApplicationComponents page.

type ListApplicationComponentsPaginatorOptions 

type ListApplicationComponentsPaginatorOptions struct {
	// The maximum number of items to include in the response. The maximum value is
	// 100.
	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
}

ListApplicationComponentsPaginatorOptions is the paginator options for ListApplicationComponents

type ListCollectorsAPIClient 

type ListCollectorsAPIClient interface {
	ListCollectors(context.Context, *ListCollectorsInput, ...func(*Options)) (*ListCollectorsOutput, error)
}

ListCollectorsAPIClient is a client that implements the ListCollectors operation.

type ListCollectorsInput 

type ListCollectorsInput struct {

	// The maximum number of items to include in the response. The maximum value is
	// 100.
	MaxResults *int32

	// The token from a previous call that you use to retrieve the next set of
	// results. For example, if a previous call to this action returned 100 items, but
	// you set maxResults to 10. You'll receive a set of 10 results along with a
	// token. You then use the returned token to retrieve the next set of 10.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCollectorsOutput 

type ListCollectorsOutput struct {

	// The list of all the installed collectors.
	Collectors []types.Collector

	// The token you use to retrieve the next set of results, or null if there are no
	// more results.
	NextToken *string

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

type ListCollectorsPaginator 

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

ListCollectorsPaginator is a paginator for ListCollectors

func NewListCollectorsPaginator 

func NewListCollectorsPaginator(client ListCollectorsAPIClient, params *ListCollectorsInput, optFns ...func(*ListCollectorsPaginatorOptions)) *ListCollectorsPaginator

NewListCollectorsPaginator returns a new ListCollectorsPaginator

func (*ListCollectorsPaginator) HasMorePages 

func (p *ListCollectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCollectorsPaginator) NextPage 

func (p *ListCollectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCollectorsOutput, error)

NextPage retrieves the next ListCollectors page.

type ListCollectorsPaginatorOptions 

type ListCollectorsPaginatorOptions struct {
	// The maximum number of items to include in the response. The maximum value is
	// 100.
	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
}

ListCollectorsPaginatorOptions is the paginator options for ListCollectors

type ListImportFileTaskAPIClient 

type ListImportFileTaskAPIClient interface {
	ListImportFileTask(context.Context, *ListImportFileTaskInput, ...func(*Options)) (*ListImportFileTaskOutput, error)
}

ListImportFileTaskAPIClient is a client that implements the ListImportFileTask operation.

type ListImportFileTaskInput 

type ListImportFileTaskInput struct {

	// The total number of items to return. The maximum value is 100.
	MaxResults *int32

	// The token from a previous call that you use to retrieve the next set of
	// results. For example, if a previous call to this action returned 100 items, but
	// you set maxResults to 10. You'll receive a set of 10 results along with a
	// token. You then use the returned token to retrieve the next set of 10.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImportFileTaskOutput 

type ListImportFileTaskOutput struct {

	// The token you use to retrieve the next set of results, or null if there are no
	// more results.
	NextToken *string

	// Lists information about the files you import.
	TaskInfos []types.ImportFileTaskInformation

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

type ListImportFileTaskPaginator 

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

ListImportFileTaskPaginator is a paginator for ListImportFileTask

func NewListImportFileTaskPaginator 

func NewListImportFileTaskPaginator(client ListImportFileTaskAPIClient, params *ListImportFileTaskInput, optFns ...func(*ListImportFileTaskPaginatorOptions)) *ListImportFileTaskPaginator

NewListImportFileTaskPaginator returns a new ListImportFileTaskPaginator

func (*ListImportFileTaskPaginator) HasMorePages 

func (p *ListImportFileTaskPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImportFileTaskPaginator) NextPage 

func (p *ListImportFileTaskPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImportFileTaskOutput, error)

NextPage retrieves the next ListImportFileTask page.

type ListImportFileTaskPaginatorOptions 

type ListImportFileTaskPaginatorOptions struct {
	// The total number of items to return. The maximum value is 100.
	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
}

ListImportFileTaskPaginatorOptions is the paginator options for ListImportFileTask

type ListServersAPIClient 

type ListServersAPIClient interface {
	ListServers(context.Context, *ListServersInput, ...func(*Options)) (*ListServersOutput, error)
}

ListServersAPIClient is a client that implements the ListServers operation.

type ListServersInput 

type ListServersInput struct {

	// Specifies the filter value, which is based on the type of server criteria. For
	// example, if serverCriteria is OS_NAME , and the filterValue is equal to
	// WindowsServer , then ListServers returns all of the servers matching the OS
	// name WindowsServer .
	FilterValue *string

	// Specifies the group ID to filter on.
	GroupIdFilter []types.Group

	// The maximum number of items to include in the response. The maximum value is
	// 100.
	MaxResults *int32

	// The token from a previous call that you use to retrieve the next set of
	// results. For example, if a previous call to this action returned 100 items, but
	// you set maxResults to 10. You'll receive a set of 10 results along with a
	// token. You then use the returned token to retrieve the next set of 10.
	NextToken *string

	// Criteria for filtering servers.
	ServerCriteria types.ServerCriteria

	// Specifies whether to sort by ascending ( ASC ) or descending ( DESC ) order.
	Sort types.SortOrder
	// contains filtered or unexported fields
}

type ListServersOutput 

type ListServersOutput struct {

	// The token you use to retrieve the next set of results, or null if there are no
	// more results.
	NextToken *string

	// The list of servers with detailed information about each server.
	ServerInfos []types.ServerDetail

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

type ListServersPaginator 

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

ListServersPaginator is a paginator for ListServers

func NewListServersPaginator 

func NewListServersPaginator(client ListServersAPIClient, params *ListServersInput, optFns ...func(*ListServersPaginatorOptions)) *ListServersPaginator

NewListServersPaginator returns a new ListServersPaginator

func (*ListServersPaginator) HasMorePages 

func (p *ListServersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListServersPaginator) NextPage 

func (p *ListServersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListServersOutput, error)

NextPage retrieves the next ListServers page.

type ListServersPaginatorOptions 

type ListServersPaginatorOptions struct {
	// The maximum number of items to include in the response. The maximum value is
	// 100.
	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
}

ListServersPaginatorOptions is the paginator options for ListServers

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

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

type PutPortfolioPreferencesInput 

type PutPortfolioPreferencesInput struct {

	// The classification for application component types.
	ApplicationMode types.ApplicationMode

	// The transformation preferences for non-database applications.
	ApplicationPreferences *types.ApplicationPreferences

	// The transformation preferences for database applications.
	DatabasePreferences *types.DatabasePreferences

	// The rank of the business goals based on priority.
	PrioritizeBusinessGoals *types.PrioritizeBusinessGoals
	// contains filtered or unexported fields
}

type PutPortfolioPreferencesOutput 

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

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 StartAssessmentInput 

type StartAssessmentInput struct {

	// The data source type of an assessment to be started.
	AssessmentDataSourceType types.AssessmentDataSourceType

	// List of criteria for assessment.
	AssessmentTargets []types.AssessmentTarget

	// The S3 bucket used by the collectors to send analysis data to the service. The
	// bucket name must begin with migrationhub-strategy- .
	S3bucketForAnalysisData *string

	// The S3 bucket where all the reports generated by the service are stored. The
	// bucket name must begin with migrationhub-strategy- .
	S3bucketForReportData *string
	// contains filtered or unexported fields
}

type StartAssessmentOutput 

type StartAssessmentOutput struct {

	// The ID of the assessment.
	AssessmentId *string

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

type StartImportFileTaskInput 

type StartImportFileTaskInput struct {

	// A descriptive name for the request.
	//
	// This member is required.
	Name *string

	// The S3 bucket where the import file is located. The bucket name is required to
	// begin with migrationhub-strategy- .
	//
	// This member is required.
	S3Bucket *string

	// The Amazon S3 key name of the import file.
	//
	// This member is required.
	S3key *string

	// Specifies the source that the servers are coming from. By default, Strategy
	// Recommendations assumes that the servers specified in the import file are
	// available in AWS Application Discovery Service.
	DataSourceType types.DataSourceType

	// Groups the resources in the import file together with a unique name. This ID
	// can be as filter in ListApplicationComponents and ListServers .
	GroupId []types.Group

	// The S3 bucket where Strategy Recommendations uploads import results. The bucket
	// name is required to begin with migrationhub-strategy-.
	S3bucketForReportData *string
	// contains filtered or unexported fields
}

type StartImportFileTaskOutput 

type StartImportFileTaskOutput struct {

	// The ID for a specific import task. The ID is unique within an AWS account.
	Id *string

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

type StartRecommendationReportGenerationInput 

type StartRecommendationReportGenerationInput struct {

	// Groups the resources in the recommendation report with a unique name.
	GroupIdFilter []types.Group

	// The output format for the recommendation report file. The default format is
	// Microsoft Excel.
	OutputFormat types.OutputFormat
	// contains filtered or unexported fields
}

type StartRecommendationReportGenerationOutput 

type StartRecommendationReportGenerationOutput struct {

	// The ID of the recommendation report generation task.
	Id *string

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

type StopAssessmentInput 

type StopAssessmentInput struct {

	// The assessmentId returned by StartAssessment .
	//
	// This member is required.
	AssessmentId *string
	// contains filtered or unexported fields
}

type StopAssessmentOutput 

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

type UpdateApplicationComponentConfigInput 

type UpdateApplicationComponentConfigInput struct {

	// The ID of the application component. The ID is unique within an AWS account.
	//
	// This member is required.
	ApplicationComponentId *string

	// The type of known component.
	AppType types.AppType

	// Update the configuration request of an application component. If it is set to
	// true, the source code and/or database credentials are updated. If it is set to
	// false, the source code and/or database credentials are updated and an analysis
	// is initiated.
	ConfigureOnly *bool

	// Indicates whether the application component has been included for server
	// recommendation or not.
	InclusionStatus types.InclusionStatus

	// Database credentials.
	SecretsManagerKey *string

	// The list of source code configurations to update for the application component.
	SourceCodeList []types.SourceCode

	// The preferred strategy options for the application component. Use values from
	// the GetApplicationComponentStrategies response.
	StrategyOption *types.StrategyOption
	// contains filtered or unexported fields
}

type UpdateApplicationComponentConfigOutput 

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

type UpdateServerConfigInput 

type UpdateServerConfigInput struct {

	// The ID of the server.
	//
	// This member is required.
	ServerId *string

	// The preferred strategy options for the application component. See the response
	// from GetServerStrategies .
	StrategyOption *types.StrategyOption
	// contains filtered or unexported fields
}

type UpdateServerConfigOutput 

type UpdateServerConfigOutput 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.