fis

package module
v1.31.1 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 44 Imported by: 18

Documentation

Overview

Package fis provides the API client, operations, and parameter types for AWS Fault Injection Simulator.

Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Service User Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-12-01"
View Source 
const ServiceID = "fis"

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.15.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.19.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.19.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.19.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.19.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 AWS Fault Injection Simulator.

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

func (c *Client) CreateExperimentTemplate(ctx context.Context, params *CreateExperimentTemplateInput, optFns ...func(*Options)) (*CreateExperimentTemplateOutput, error)

Creates an experiment template.

An experiment template includes the following components:

  • Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.

  • Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.

  • Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.

For more information, see experiment templates in the Fault Injection Service User Guide.

func (*Client) CreateTargetAccountConfiguration added in v1.20.0 

func (c *Client) CreateTargetAccountConfiguration(ctx context.Context, params *CreateTargetAccountConfigurationInput, optFns ...func(*Options)) (*CreateTargetAccountConfigurationOutput, error)

Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account . For more information, see experiment options in the Fault Injection Service User Guide.

func (*Client) DeleteExperimentTemplate 

func (c *Client) DeleteExperimentTemplate(ctx context.Context, params *DeleteExperimentTemplateInput, optFns ...func(*Options)) (*DeleteExperimentTemplateOutput, error)

Deletes the specified experiment template.

func (*Client) DeleteTargetAccountConfiguration added in v1.20.0 

func (c *Client) DeleteTargetAccountConfiguration(ctx context.Context, params *DeleteTargetAccountConfigurationInput, optFns ...func(*Options)) (*DeleteTargetAccountConfigurationOutput, error)

Deletes the specified target account configuration of the experiment template.

func (*Client) GetAction 

func (c *Client) GetAction(ctx context.Context, params *GetActionInput, optFns ...func(*Options)) (*GetActionOutput, error)

Gets information about the specified FIS action.

func (*Client) GetExperiment 

func (c *Client) GetExperiment(ctx context.Context, params *GetExperimentInput, optFns ...func(*Options)) (*GetExperimentOutput, error)

Gets information about the specified experiment.

func (*Client) GetExperimentTargetAccountConfiguration added in v1.20.0 

func (c *Client) GetExperimentTargetAccountConfiguration(ctx context.Context, params *GetExperimentTargetAccountConfigurationInput, optFns ...func(*Options)) (*GetExperimentTargetAccountConfigurationOutput, error)

Gets information about the specified target account configuration of the experiment.

func (*Client) GetExperimentTemplate 

func (c *Client) GetExperimentTemplate(ctx context.Context, params *GetExperimentTemplateInput, optFns ...func(*Options)) (*GetExperimentTemplateOutput, error)

Gets information about the specified experiment template.

func (*Client) GetSafetyLever added in v1.28.0 

func (c *Client) GetSafetyLever(ctx context.Context, params *GetSafetyLeverInput, optFns ...func(*Options)) (*GetSafetyLeverOutput, error)

Gets information about the specified safety lever.

func (*Client) GetTargetAccountConfiguration added in v1.20.0 

func (c *Client) GetTargetAccountConfiguration(ctx context.Context, params *GetTargetAccountConfigurationInput, optFns ...func(*Options)) (*GetTargetAccountConfigurationOutput, error)

Gets information about the specified target account configuration of the experiment template.

func (*Client) GetTargetResourceType added in v1.11.0 

func (c *Client) GetTargetResourceType(ctx context.Context, params *GetTargetResourceTypeInput, optFns ...func(*Options)) (*GetTargetResourceTypeOutput, error)

Gets information about the specified resource type.

func (*Client) ListActions 

func (c *Client) ListActions(ctx context.Context, params *ListActionsInput, optFns ...func(*Options)) (*ListActionsOutput, error)

Lists the available FIS actions.

func (*Client) ListExperimentResolvedTargets added in v1.20.0 

func (c *Client) ListExperimentResolvedTargets(ctx context.Context, params *ListExperimentResolvedTargetsInput, optFns ...func(*Options)) (*ListExperimentResolvedTargetsOutput, error)

Lists the resolved targets information of the specified experiment.

func (*Client) ListExperimentTargetAccountConfigurations added in v1.20.0 

func (c *Client) ListExperimentTargetAccountConfigurations(ctx context.Context, params *ListExperimentTargetAccountConfigurationsInput, optFns ...func(*Options)) (*ListExperimentTargetAccountConfigurationsOutput, error)

Lists the target account configurations of the specified experiment.

func (*Client) ListExperimentTemplates 

func (c *Client) ListExperimentTemplates(ctx context.Context, params *ListExperimentTemplatesInput, optFns ...func(*Options)) (*ListExperimentTemplatesOutput, error)

Lists your experiment templates.

func (*Client) ListExperiments 

func (c *Client) ListExperiments(ctx context.Context, params *ListExperimentsInput, optFns ...func(*Options)) (*ListExperimentsOutput, error)

Lists your experiments.

func (*Client) ListTagsForResource 

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

Lists the tags for the specified resource.

func (*Client) ListTargetAccountConfigurations added in v1.20.0 

func (c *Client) ListTargetAccountConfigurations(ctx context.Context, params *ListTargetAccountConfigurationsInput, optFns ...func(*Options)) (*ListTargetAccountConfigurationsOutput, error)

Lists the target account configurations of the specified experiment template.

func (*Client) ListTargetResourceTypes added in v1.11.0 

func (c *Client) ListTargetResourceTypes(ctx context.Context, params *ListTargetResourceTypesInput, optFns ...func(*Options)) (*ListTargetResourceTypesOutput, error)

Lists the target resource types.

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

func (c *Client) StartExperiment(ctx context.Context, params *StartExperimentInput, optFns ...func(*Options)) (*StartExperimentOutput, error)

Starts running an experiment from the specified experiment template.

func (*Client) StopExperiment 

func (c *Client) StopExperiment(ctx context.Context, params *StopExperimentInput, optFns ...func(*Options)) (*StopExperimentOutput, error)

Stops the specified experiment.

func (*Client) TagResource 

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

Applies the specified tags to the specified resource.

func (*Client) UntagResource 

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

Removes the specified tags from the specified resource.

func (*Client) UpdateExperimentTemplate 

func (c *Client) UpdateExperimentTemplate(ctx context.Context, params *UpdateExperimentTemplateInput, optFns ...func(*Options)) (*UpdateExperimentTemplateOutput, error)

Updates the specified experiment template.

func (*Client) UpdateSafetyLeverState added in v1.28.0 

func (c *Client) UpdateSafetyLeverState(ctx context.Context, params *UpdateSafetyLeverStateInput, optFns ...func(*Options)) (*UpdateSafetyLeverStateOutput, error)

Updates the specified safety lever state.

func (*Client) UpdateTargetAccountConfiguration added in v1.20.0 

func (c *Client) UpdateTargetAccountConfiguration(ctx context.Context, params *UpdateTargetAccountConfigurationInput, optFns ...func(*Options)) (*UpdateTargetAccountConfigurationOutput, error)

Updates the target account configuration for the specified experiment template.

type CreateExperimentTemplateInput 

type CreateExperimentTemplateInput struct {

	// The actions for the experiment.
	//
	// This member is required.
	Actions map[string]types.CreateExperimentTemplateActionInput

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// A description for the experiment template.
	//
	// This member is required.
	Description *string

	// The Amazon Resource Name (ARN) of an IAM role that grants the FIS service
	// permission to perform service actions on your behalf.
	//
	// This member is required.
	RoleArn *string

	// The stop conditions.
	//
	// This member is required.
	StopConditions []types.CreateExperimentTemplateStopConditionInput

	// The experiment options for the experiment template.
	ExperimentOptions *types.CreateExperimentTemplateExperimentOptionsInput

	// The experiment report configuration for the experiment template.
	ExperimentReportConfiguration *types.CreateExperimentTemplateReportConfigurationInput

	// The configuration for experiment logging.
	LogConfiguration *types.CreateExperimentTemplateLogConfigurationInput

	// The tags to apply to the experiment template.
	Tags map[string]string

	// The targets for the experiment.
	Targets map[string]types.CreateExperimentTemplateTargetInput
	// contains filtered or unexported fields
}

type CreateExperimentTemplateOutput 

type CreateExperimentTemplateOutput struct {

	// Information about the experiment template.
	ExperimentTemplate *types.ExperimentTemplate

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

type CreateTargetAccountConfigurationInput added in v1.20.0 

type CreateTargetAccountConfigurationInput struct {

	// The Amazon Web Services account ID of the target account.
	//
	// This member is required.
	AccountId *string

	// The experiment template ID.
	//
	// This member is required.
	ExperimentTemplateId *string

	// The Amazon Resource Name (ARN) of an IAM role for the target account.
	//
	// This member is required.
	RoleArn *string

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	ClientToken *string

	// The description of the target account.
	Description *string
	// contains filtered or unexported fields
}

type CreateTargetAccountConfigurationOutput added in v1.20.0 

type CreateTargetAccountConfigurationOutput struct {

	// Information about the target account configuration.
	TargetAccountConfiguration *types.TargetAccountConfiguration

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

type DeleteExperimentTemplateInput 

type DeleteExperimentTemplateInput struct {

	// The ID of the experiment template.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteExperimentTemplateOutput 

type DeleteExperimentTemplateOutput struct {

	// Information about the experiment template.
	ExperimentTemplate *types.ExperimentTemplate

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

type DeleteTargetAccountConfigurationInput added in v1.20.0 

type DeleteTargetAccountConfigurationInput struct {

	// The Amazon Web Services account ID of the target account.
	//
	// This member is required.
	AccountId *string

	// The ID of the experiment template.
	//
	// This member is required.
	ExperimentTemplateId *string
	// contains filtered or unexported fields
}

type DeleteTargetAccountConfigurationOutput added in v1.20.0 

type DeleteTargetAccountConfigurationOutput struct {

	// Information about the target account configuration.
	TargetAccountConfiguration *types.TargetAccountConfiguration

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

type EndpointParameters added in v1.15.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.15.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.15.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.15.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.15.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetActionInput 

type GetActionInput struct {

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

type GetActionOutput 

type GetActionOutput struct {

	// Information about the action.
	Action *types.Action

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

type GetExperimentInput 

type GetExperimentInput struct {

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

type GetExperimentOutput 

type GetExperimentOutput struct {

	// Information about the experiment.
	Experiment *types.Experiment

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

type GetExperimentTargetAccountConfigurationInput added in v1.20.0 

type GetExperimentTargetAccountConfigurationInput struct {

	// The Amazon Web Services account ID of the target account.
	//
	// This member is required.
	AccountId *string

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

type GetExperimentTargetAccountConfigurationOutput added in v1.20.0 

type GetExperimentTargetAccountConfigurationOutput struct {

	// Information about the target account configuration.
	TargetAccountConfiguration *types.ExperimentTargetAccountConfiguration

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

type GetExperimentTemplateInput 

type GetExperimentTemplateInput struct {

	// The ID of the experiment template.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetExperimentTemplateOutput 

type GetExperimentTemplateOutput struct {

	// Information about the experiment template.
	ExperimentTemplate *types.ExperimentTemplate

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

type GetSafetyLeverInput added in v1.28.0 

type GetSafetyLeverInput struct {

	//  The ID of the safety lever.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetSafetyLeverOutput added in v1.28.0 

type GetSafetyLeverOutput struct {

	//  Information about the safety lever.
	SafetyLever *types.SafetyLever

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

type GetTargetAccountConfigurationInput added in v1.20.0 

type GetTargetAccountConfigurationInput struct {

	// The Amazon Web Services account ID of the target account.
	//
	// This member is required.
	AccountId *string

	// The ID of the experiment template.
	//
	// This member is required.
	ExperimentTemplateId *string
	// contains filtered or unexported fields
}

type GetTargetAccountConfigurationOutput added in v1.20.0 

type GetTargetAccountConfigurationOutput struct {

	// Information about the target account configuration.
	TargetAccountConfiguration *types.TargetAccountConfiguration

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

type GetTargetResourceTypeInput added in v1.11.0 

type GetTargetResourceTypeInput struct {

	// The resource type.
	//
	// This member is required.
	ResourceType *string
	// contains filtered or unexported fields
}

type GetTargetResourceTypeOutput added in v1.11.0 

type GetTargetResourceTypeOutput struct {

	// Information about the resource type.
	TargetResourceType *types.TargetResourceType

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

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListActionsAPIClient 

type ListActionsAPIClient interface {
	ListActions(context.Context, *ListActionsInput, ...func(*Options)) (*ListActionsOutput, error)
}

ListActionsAPIClient is a client that implements the ListActions operation.

type ListActionsInput 

type ListActionsInput struct {

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListActionsOutput 

type ListActionsOutput struct {

	// The actions.
	Actions []types.ActionSummary

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

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

type ListActionsPaginator 

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

ListActionsPaginator is a paginator for ListActions

func NewListActionsPaginator 

func NewListActionsPaginator(client ListActionsAPIClient, params *ListActionsInput, optFns ...func(*ListActionsPaginatorOptions)) *ListActionsPaginator

NewListActionsPaginator returns a new ListActionsPaginator

func (*ListActionsPaginator) HasMorePages 

func (p *ListActionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListActionsPaginator) NextPage 

func (p *ListActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListActionsOutput, error)

NextPage retrieves the next ListActions page.

type ListActionsPaginatorOptions 

type ListActionsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListActionsPaginatorOptions is the paginator options for ListActions

type ListExperimentResolvedTargetsAPIClient added in v1.20.0 

type ListExperimentResolvedTargetsAPIClient interface {
	ListExperimentResolvedTargets(context.Context, *ListExperimentResolvedTargetsInput, ...func(*Options)) (*ListExperimentResolvedTargetsOutput, error)
}

ListExperimentResolvedTargetsAPIClient is a client that implements the ListExperimentResolvedTargets operation.

type ListExperimentResolvedTargetsInput added in v1.20.0 

type ListExperimentResolvedTargetsInput struct {

	// The ID of the experiment.
	//
	// This member is required.
	ExperimentId *string

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string

	// The name of the target.
	TargetName *string
	// contains filtered or unexported fields
}

type ListExperimentResolvedTargetsOutput added in v1.20.0 

type ListExperimentResolvedTargetsOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The resolved targets.
	ResolvedTargets []types.ResolvedTarget

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

type ListExperimentResolvedTargetsPaginator added in v1.20.0 

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

ListExperimentResolvedTargetsPaginator is a paginator for ListExperimentResolvedTargets

func NewListExperimentResolvedTargetsPaginator added in v1.20.0 

func NewListExperimentResolvedTargetsPaginator(client ListExperimentResolvedTargetsAPIClient, params *ListExperimentResolvedTargetsInput, optFns ...func(*ListExperimentResolvedTargetsPaginatorOptions)) *ListExperimentResolvedTargetsPaginator

NewListExperimentResolvedTargetsPaginator returns a new ListExperimentResolvedTargetsPaginator

func (*ListExperimentResolvedTargetsPaginator) HasMorePages added in v1.20.0 

func (p *ListExperimentResolvedTargetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExperimentResolvedTargetsPaginator) NextPage added in v1.20.0 

func (p *ListExperimentResolvedTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExperimentResolvedTargetsOutput, error)

NextPage retrieves the next ListExperimentResolvedTargets page.

type ListExperimentResolvedTargetsPaginatorOptions added in v1.20.0 

type ListExperimentResolvedTargetsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListExperimentResolvedTargetsPaginatorOptions is the paginator options for ListExperimentResolvedTargets

type ListExperimentTargetAccountConfigurationsInput added in v1.20.0 

type ListExperimentTargetAccountConfigurationsInput struct {

	// The ID of the experiment.
	//
	// This member is required.
	ExperimentId *string

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListExperimentTargetAccountConfigurationsOutput added in v1.20.0 

type ListExperimentTargetAccountConfigurationsOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The target account configurations.
	TargetAccountConfigurations []types.ExperimentTargetAccountConfigurationSummary

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

type ListExperimentTemplatesAPIClient 

type ListExperimentTemplatesAPIClient interface {
	ListExperimentTemplates(context.Context, *ListExperimentTemplatesInput, ...func(*Options)) (*ListExperimentTemplatesOutput, error)
}

ListExperimentTemplatesAPIClient is a client that implements the ListExperimentTemplates operation.

type ListExperimentTemplatesInput 

type ListExperimentTemplatesInput struct {

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListExperimentTemplatesOutput 

type ListExperimentTemplatesOutput struct {

	// The experiment templates.
	ExperimentTemplates []types.ExperimentTemplateSummary

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

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

type ListExperimentTemplatesPaginator 

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

ListExperimentTemplatesPaginator is a paginator for ListExperimentTemplates

func NewListExperimentTemplatesPaginator 

func NewListExperimentTemplatesPaginator(client ListExperimentTemplatesAPIClient, params *ListExperimentTemplatesInput, optFns ...func(*ListExperimentTemplatesPaginatorOptions)) *ListExperimentTemplatesPaginator

NewListExperimentTemplatesPaginator returns a new ListExperimentTemplatesPaginator

func (*ListExperimentTemplatesPaginator) HasMorePages 

func (p *ListExperimentTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExperimentTemplatesPaginator) NextPage 

func (p *ListExperimentTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExperimentTemplatesOutput, error)

NextPage retrieves the next ListExperimentTemplates page.

type ListExperimentTemplatesPaginatorOptions 

type ListExperimentTemplatesPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListExperimentTemplatesPaginatorOptions is the paginator options for ListExperimentTemplates

type ListExperimentsAPIClient 

type ListExperimentsAPIClient interface {
	ListExperiments(context.Context, *ListExperimentsInput, ...func(*Options)) (*ListExperimentsOutput, error)
}

ListExperimentsAPIClient is a client that implements the ListExperiments operation.

type ListExperimentsInput 

type ListExperimentsInput struct {

	// The ID of the experiment template.
	ExperimentTemplateId *string

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListExperimentsOutput 

type ListExperimentsOutput struct {

	// The experiments.
	Experiments []types.ExperimentSummary

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

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

type ListExperimentsPaginator 

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

ListExperimentsPaginator is a paginator for ListExperiments

func NewListExperimentsPaginator 

func NewListExperimentsPaginator(client ListExperimentsAPIClient, params *ListExperimentsInput, optFns ...func(*ListExperimentsPaginatorOptions)) *ListExperimentsPaginator

NewListExperimentsPaginator returns a new ListExperimentsPaginator

func (*ListExperimentsPaginator) HasMorePages 

func (p *ListExperimentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExperimentsPaginator) NextPage 

func (p *ListExperimentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExperimentsOutput, error)

NextPage retrieves the next ListExperiments page.

type ListExperimentsPaginatorOptions 

type ListExperimentsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListExperimentsPaginatorOptions is the paginator options for ListExperiments

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags for the resource.
	Tags map[string]string

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

type ListTargetAccountConfigurationsAPIClient added in v1.20.0 

type ListTargetAccountConfigurationsAPIClient interface {
	ListTargetAccountConfigurations(context.Context, *ListTargetAccountConfigurationsInput, ...func(*Options)) (*ListTargetAccountConfigurationsOutput, error)
}

ListTargetAccountConfigurationsAPIClient is a client that implements the ListTargetAccountConfigurations operation.

type ListTargetAccountConfigurationsInput added in v1.20.0 

type ListTargetAccountConfigurationsInput struct {

	// The ID of the experiment template.
	//
	// This member is required.
	ExperimentTemplateId *string

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTargetAccountConfigurationsOutput added in v1.20.0 

type ListTargetAccountConfigurationsOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The target account configurations.
	TargetAccountConfigurations []types.TargetAccountConfigurationSummary

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

type ListTargetAccountConfigurationsPaginator added in v1.20.0 

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

ListTargetAccountConfigurationsPaginator is a paginator for ListTargetAccountConfigurations

func NewListTargetAccountConfigurationsPaginator added in v1.20.0 

func NewListTargetAccountConfigurationsPaginator(client ListTargetAccountConfigurationsAPIClient, params *ListTargetAccountConfigurationsInput, optFns ...func(*ListTargetAccountConfigurationsPaginatorOptions)) *ListTargetAccountConfigurationsPaginator

NewListTargetAccountConfigurationsPaginator returns a new ListTargetAccountConfigurationsPaginator

func (*ListTargetAccountConfigurationsPaginator) HasMorePages added in v1.20.0 

func (p *ListTargetAccountConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTargetAccountConfigurationsPaginator) NextPage added in v1.20.0 

func (p *ListTargetAccountConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTargetAccountConfigurationsOutput, error)

NextPage retrieves the next ListTargetAccountConfigurations page.

type ListTargetAccountConfigurationsPaginatorOptions added in v1.20.0 

type ListTargetAccountConfigurationsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListTargetAccountConfigurationsPaginatorOptions is the paginator options for ListTargetAccountConfigurations

type ListTargetResourceTypesAPIClient added in v1.11.0 

type ListTargetResourceTypesAPIClient interface {
	ListTargetResourceTypes(context.Context, *ListTargetResourceTypesInput, ...func(*Options)) (*ListTargetResourceTypesOutput, error)
}

ListTargetResourceTypesAPIClient is a client that implements the ListTargetResourceTypes operation.

type ListTargetResourceTypesInput added in v1.11.0 

type ListTargetResourceTypesInput struct {

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTargetResourceTypesOutput added in v1.11.0 

type ListTargetResourceTypesOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The target resource types.
	TargetResourceTypes []types.TargetResourceTypeSummary

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

type ListTargetResourceTypesPaginator added in v1.11.0 

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

ListTargetResourceTypesPaginator is a paginator for ListTargetResourceTypes

func NewListTargetResourceTypesPaginator added in v1.11.0 

func NewListTargetResourceTypesPaginator(client ListTargetResourceTypesAPIClient, params *ListTargetResourceTypesInput, optFns ...func(*ListTargetResourceTypesPaginatorOptions)) *ListTargetResourceTypesPaginator

NewListTargetResourceTypesPaginator returns a new ListTargetResourceTypesPaginator

func (*ListTargetResourceTypesPaginator) HasMorePages added in v1.11.0 

func (p *ListTargetResourceTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTargetResourceTypesPaginator) NextPage added in v1.11.0 

func (p *ListTargetResourceTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTargetResourceTypesOutput, error)

NextPage retrieves the next ListTargetResourceTypes page.

type ListTargetResourceTypesPaginatorOptions added in v1.11.0 

type ListTargetResourceTypesPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListTargetResourceTypesPaginatorOptions is the paginator options for ListTargetResourceTypes

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

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

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 StartExperimentInput 

type StartExperimentInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request.
	//
	// This member is required.
	ClientToken *string

	// The ID of the experiment template.
	//
	// This member is required.
	ExperimentTemplateId *string

	// The experiment options for running the experiment.
	ExperimentOptions *types.StartExperimentExperimentOptionsInput

	// The tags to apply to the experiment.
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartExperimentOutput 

type StartExperimentOutput struct {

	// Information about the experiment.
	Experiment *types.Experiment

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

type StopExperimentInput 

type StopExperimentInput struct {

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

type StopExperimentOutput 

type StopExperimentOutput struct {

	// Information about the experiment.
	Experiment *types.Experiment

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

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags for the resource.
	//
	// This member is required.
	Tags map[string]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 Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The tag keys to remove.
	TagKeys []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 UpdateExperimentTemplateInput 

type UpdateExperimentTemplateInput struct {

	// The ID of the experiment template.
	//
	// This member is required.
	Id *string

	// The actions for the experiment.
	Actions map[string]types.UpdateExperimentTemplateActionInputItem

	// A description for the template.
	Description *string

	// The experiment options for the experiment template.
	ExperimentOptions *types.UpdateExperimentTemplateExperimentOptionsInput

	// The experiment report configuration for the experiment template.
	ExperimentReportConfiguration *types.UpdateExperimentTemplateReportConfigurationInput

	// The configuration for experiment logging.
	LogConfiguration *types.UpdateExperimentTemplateLogConfigurationInput

	// The Amazon Resource Name (ARN) of an IAM role that grants the FIS service
	// permission to perform service actions on your behalf.
	RoleArn *string

	// The stop conditions for the experiment.
	StopConditions []types.UpdateExperimentTemplateStopConditionInput

	// The targets for the experiment.
	Targets map[string]types.UpdateExperimentTemplateTargetInput
	// contains filtered or unexported fields
}

type UpdateExperimentTemplateOutput 

type UpdateExperimentTemplateOutput struct {

	// Information about the experiment template.
	ExperimentTemplate *types.ExperimentTemplate

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

type UpdateSafetyLeverStateInput added in v1.28.0 

type UpdateSafetyLeverStateInput struct {

	//  The ID of the safety lever.
	//
	// This member is required.
	Id *string

	//  The state of the safety lever.
	//
	// This member is required.
	State *types.UpdateSafetyLeverStateInput
	// contains filtered or unexported fields
}

type UpdateSafetyLeverStateOutput added in v1.28.0 

type UpdateSafetyLeverStateOutput struct {

	//  Information about the safety lever.
	SafetyLever *types.SafetyLever

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

type UpdateTargetAccountConfigurationInput added in v1.20.0 

type UpdateTargetAccountConfigurationInput struct {

	// The Amazon Web Services account ID of the target account.
	//
	// This member is required.
	AccountId *string

	// The ID of the experiment template.
	//
	// This member is required.
	ExperimentTemplateId *string

	// The description of the target account.
	Description *string

	// The Amazon Resource Name (ARN) of an IAM role for the target account.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateTargetAccountConfigurationOutput added in v1.20.0 

type UpdateTargetAccountConfigurationOutput struct {

	// Information about the target account configuration.
	TargetAccountConfiguration *types.TargetAccountConfiguration

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