appconfigdata

package
v1.46.4 Latest Latest
Warning

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

Go to latest
Published: Oct 25, 2023 License: Apache-2.0 Imports: 9 Imported by: 18

Documentation

Overview

Package appconfigdata provides the client and types for making API requests to AWS AppConfig Data.

AppConfig Data provides the data plane APIs your application uses to retrieve configuration data. Here's how it works:

Your application retrieves configuration data by first establishing a configuration session using the AppConfig Data StartConfigurationSession API action. Your session's client then makes periodic calls to GetLatestConfiguration to check for and retrieve the latest data available.

When calling StartConfigurationSession, your code sends the following information:

  • Identifiers (ID or name) of an AppConfig application, environment, and configuration profile that the session tracks.

  • (Optional) The minimum amount of time the session's client must wait between calls to GetLatestConfiguration.

In response, AppConfig provides an InitialConfigurationToken to be given to the session's client and used the first time it calls GetLatestConfiguration for that session.

This token should only be used once in your first call to GetLatestConfiguration. You must use the new token in the GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration.

When calling GetLatestConfiguration, your client code sends the most recent ConfigurationToken value it has and receives in response:

  • NextPollConfigurationToken: the ConfigurationToken value to use on the next call to GetLatestConfiguration.

  • NextPollIntervalInSeconds: the duration the client should wait before making its next call to GetLatestConfiguration. This duration may vary over the course of the session, so it should be used instead of the value sent on the StartConfigurationSession call.

  • The configuration: the latest data intended for the session. This may be empty if the client already has the latest version of the configuration.

The InitialConfigurationToken and NextPollConfigurationToken should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException.

For more information and to view example CLI commands that show how to retrieve a configuration using the AppConfig Data StartConfigurationSession and GetLatestConfiguration API actions, see Retrieving the configuration (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) in the AppConfig User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11 for more information on this service.

See appconfigdata package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/appconfigdata/

Using the Client

To contact AWS AppConfig Data with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS AppConfig Data client AppConfigData for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/appconfigdata/#New

Index

Constants

View Source
const (
	// InvalidParameterProblemCorrupted is a InvalidParameterProblem enum value
	InvalidParameterProblemCorrupted = "Corrupted"

	// InvalidParameterProblemExpired is a InvalidParameterProblem enum value
	InvalidParameterProblemExpired = "Expired"

	// InvalidParameterProblemPollIntervalNotSatisfied is a InvalidParameterProblem enum value
	InvalidParameterProblemPollIntervalNotSatisfied = "PollIntervalNotSatisfied"
)
View Source
const (
	// ResourceTypeApplication is a ResourceType enum value
	ResourceTypeApplication = "Application"

	// ResourceTypeConfigurationProfile is a ResourceType enum value
	ResourceTypeConfigurationProfile = "ConfigurationProfile"

	// ResourceTypeDeployment is a ResourceType enum value
	ResourceTypeDeployment = "Deployment"

	// ResourceTypeEnvironment is a ResourceType enum value
	ResourceTypeEnvironment = "Environment"

	// ResourceTypeConfiguration is a ResourceType enum value
	ResourceTypeConfiguration = "Configuration"
)
View Source
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The input fails to satisfy the constraints specified by the service.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// There was an internal failure in the service.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"
)
View Source
const (
	ServiceName = "AppConfigData" // Name of service.
	EndpointsID = "appconfigdata" // ID to lookup a service endpoint with.
	ServiceID   = "AppConfigData" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// BadRequestReasonInvalidParameters is a BadRequestReason enum value
	BadRequestReasonInvalidParameters = "InvalidParameters"
)

Variables

This section is empty.

Functions

func BadRequestReason_Values

func BadRequestReason_Values() []string

BadRequestReason_Values returns all elements of the BadRequestReason enum

func InvalidParameterProblem_Values

func InvalidParameterProblem_Values() []string

InvalidParameterProblem_Values returns all elements of the InvalidParameterProblem enum

func ResourceType_Values

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

Types

type AppConfigData

type AppConfigData struct {
	*client.Client
}

AppConfigData provides the API operation methods for making requests to AWS AppConfig Data. See this package's package overview docs for details on the service.

AppConfigData methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *AppConfigData

New creates a new instance of the AppConfigData client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a AppConfigData client from just a session.
svc := appconfigdata.New(mySession)

// Create a AppConfigData client with additional configuration
svc := appconfigdata.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*AppConfigData) GetLatestConfiguration

func (c *AppConfigData) GetLatestConfiguration(input *GetLatestConfigurationInput) (*GetLatestConfigurationOutput, error)

GetLatestConfiguration API operation for AWS AppConfig Data.

Retrieves the latest deployed configuration. This API may return empty configuration data if the client already has the latest version. For more information about this API action and to view example CLI commands that show how to use it with the StartConfigurationSession API action, see Retrieving the configuration (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) in the AppConfig User Guide.

Note the following important information.

  • Each configuration token is only valid for one call to GetLatestConfiguration. The GetLatestConfiguration response includes a NextPollConfigurationToken that should always replace the token used for the just-completed call in preparation for the next one.

  • GetLatestConfiguration is a priced call. For more information, see Pricing (https://aws.amazon.com/systems-manager/pricing/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS AppConfig Data's API operation GetLatestConfiguration for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ResourceNotFoundException The requested resource could not be found.

  • BadRequestException The input fails to satisfy the constraints specified by the service.

  • InternalServerException There was an internal failure in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/GetLatestConfiguration

func (*AppConfigData) GetLatestConfigurationRequest

func (c *AppConfigData) GetLatestConfigurationRequest(input *GetLatestConfigurationInput) (req *request.Request, output *GetLatestConfigurationOutput)

GetLatestConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetLatestConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLatestConfiguration for more information on using the GetLatestConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLatestConfigurationRequest method.
req, resp := client.GetLatestConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/GetLatestConfiguration

func (*AppConfigData) GetLatestConfigurationWithContext

func (c *AppConfigData) GetLatestConfigurationWithContext(ctx aws.Context, input *GetLatestConfigurationInput, opts ...request.Option) (*GetLatestConfigurationOutput, error)

GetLatestConfigurationWithContext is the same as GetLatestConfiguration with the addition of the ability to pass a context and additional request options.

See GetLatestConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AppConfigData) StartConfigurationSession

func (c *AppConfigData) StartConfigurationSession(input *StartConfigurationSessionInput) (*StartConfigurationSessionOutput, error)

StartConfigurationSession API operation for AWS AppConfig Data.

Starts a configuration session used to retrieve a deployed configuration. For more information about this API action and to view example CLI commands that show how to use it with the GetLatestConfiguration API action, see Retrieving the configuration (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration) in the AppConfig User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS AppConfig Data's API operation StartConfigurationSession for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ResourceNotFoundException The requested resource could not be found.

  • BadRequestException The input fails to satisfy the constraints specified by the service.

  • InternalServerException There was an internal failure in the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/StartConfigurationSession

func (*AppConfigData) StartConfigurationSessionRequest

func (c *AppConfigData) StartConfigurationSessionRequest(input *StartConfigurationSessionInput) (req *request.Request, output *StartConfigurationSessionOutput)

StartConfigurationSessionRequest generates a "aws/request.Request" representing the client's request for the StartConfigurationSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartConfigurationSession for more information on using the StartConfigurationSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartConfigurationSessionRequest method.
req, resp := client.StartConfigurationSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/StartConfigurationSession

func (*AppConfigData) StartConfigurationSessionWithContext

func (c *AppConfigData) StartConfigurationSessionWithContext(ctx aws.Context, input *StartConfigurationSessionInput, opts ...request.Option) (*StartConfigurationSessionOutput, error)

StartConfigurationSessionWithContext is the same as StartConfigurationSession with the addition of the ability to pass a context and additional request options.

See StartConfigurationSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type BadRequestDetails

type BadRequestDetails struct {

	// One or more specified parameters are not valid for the call.
	InvalidParameters map[string]*InvalidParameterDetail `type:"map"`
	// contains filtered or unexported fields
}

Detailed information about the input that failed to satisfy the constraints specified by a call.

func (BadRequestDetails) GoString

func (s BadRequestDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequestDetails) SetInvalidParameters

func (s *BadRequestDetails) SetInvalidParameters(v map[string]*InvalidParameterDetail) *BadRequestDetails

SetInvalidParameters sets the InvalidParameters field's value.

func (BadRequestDetails) String

func (s BadRequestDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadRequestException

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Details describing why the request was invalid.
	Details *BadRequestDetails `type:"structure"`

	Message_ *string `locationName:"Message" type:"string"`

	// Code indicating the reason the request was invalid.
	Reason *string `type:"string" enum:"BadRequestReason"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by the service.

func (*BadRequestException) Code

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error

func (s *BadRequestException) Error() string

func (BadRequestException) GoString

func (s BadRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequestException) Message

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String

func (s BadRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLatestConfigurationInput

type GetLatestConfigurationInput struct {

	// Token describing the current state of the configuration session. To obtain
	// a token, first call the StartConfigurationSession API. Note that every call
	// to GetLatestConfiguration will return a new ConfigurationToken (NextPollConfigurationToken
	// in the response) and must be provided to subsequent GetLatestConfiguration
	// API calls.
	//
	// This token should only be used once. To support long poll use cases, the
	// token is valid for up to 24 hours. If a GetLatestConfiguration call uses
	// an expired token, the system returns BadRequestException.
	//
	// ConfigurationToken is a required field
	ConfigurationToken *string `location:"querystring" locationName:"configuration_token" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLatestConfigurationInput) GoString

func (s GetLatestConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLatestConfigurationInput) SetConfigurationToken

func (s *GetLatestConfigurationInput) SetConfigurationToken(v string) *GetLatestConfigurationInput

SetConfigurationToken sets the ConfigurationToken field's value.

func (GetLatestConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLatestConfigurationInput) Validate

func (s *GetLatestConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLatestConfigurationOutput

type GetLatestConfigurationOutput struct {

	// The data of the configuration. This may be empty if the client already has
	// the latest version of configuration.
	//
	// Configuration is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetLatestConfigurationOutput's
	// String and GoString methods.
	Configuration []byte `type:"blob" sensitive:"true"`

	// A standard MIME type describing the format of the configuration content.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// The latest token describing the current state of the configuration session.
	// This must be provided to the next call to GetLatestConfiguration.
	//
	// This token should only be used once. To support long poll use cases, the
	// token is valid for up to 24 hours. If a GetLatestConfiguration call uses
	// an expired token, the system returns BadRequestException.
	NextPollConfigurationToken *string `location:"header" locationName:"Next-Poll-Configuration-Token" type:"string"`

	// The amount of time the client should wait before polling for configuration
	// updates again. Use RequiredMinimumPollIntervalInSeconds to set the desired
	// poll interval.
	NextPollIntervalInSeconds *int64 `location:"header" locationName:"Next-Poll-Interval-In-Seconds" type:"integer"`

	// The user-defined label for the AppConfig hosted configuration version. This
	// attribute doesn't apply if the configuration is not from an AppConfig hosted
	// configuration version. If the client already has the latest version of the
	// configuration data, this value is empty.
	VersionLabel *string `location:"header" locationName:"Version-Label" type:"string"`
	// contains filtered or unexported fields
}

func (GetLatestConfigurationOutput) GoString

func (s GetLatestConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLatestConfigurationOutput) SetConfiguration

SetConfiguration sets the Configuration field's value.

func (*GetLatestConfigurationOutput) SetContentType

SetContentType sets the ContentType field's value.

func (*GetLatestConfigurationOutput) SetNextPollConfigurationToken

func (s *GetLatestConfigurationOutput) SetNextPollConfigurationToken(v string) *GetLatestConfigurationOutput

SetNextPollConfigurationToken sets the NextPollConfigurationToken field's value.

func (*GetLatestConfigurationOutput) SetNextPollIntervalInSeconds

func (s *GetLatestConfigurationOutput) SetNextPollIntervalInSeconds(v int64) *GetLatestConfigurationOutput

SetNextPollIntervalInSeconds sets the NextPollIntervalInSeconds field's value.

func (*GetLatestConfigurationOutput) SetVersionLabel added in v1.44.200

SetVersionLabel sets the VersionLabel field's value.

func (GetLatestConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

There was an internal failure in the service.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterDetail

type InvalidParameterDetail struct {

	// The reason the parameter is invalid.
	Problem *string `type:"string" enum:"InvalidParameterProblem"`
	// contains filtered or unexported fields
}

Information about an invalid parameter.

func (InvalidParameterDetail) GoString

func (s InvalidParameterDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterDetail) SetProblem

SetProblem sets the Problem field's value.

func (InvalidParameterDetail) String

func (s InvalidParameterDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// A map indicating which parameters in the request reference the resource that
	// was not found.
	ReferencedBy map[string]*string `type:"map"`

	// The type of resource that was not found.
	ResourceType *string `type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

The requested resource could not be found.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartConfigurationSessionInput

type StartConfigurationSessionInput struct {

	// The application ID or the application name.
	//
	// ApplicationIdentifier is a required field
	ApplicationIdentifier *string `min:"1" type:"string" required:"true"`

	// The configuration profile ID or the configuration profile name.
	//
	// ConfigurationProfileIdentifier is a required field
	ConfigurationProfileIdentifier *string `min:"1" type:"string" required:"true"`

	// The environment ID or the environment name.
	//
	// EnvironmentIdentifier is a required field
	EnvironmentIdentifier *string `min:"1" type:"string" required:"true"`

	// Sets a constraint on a session. If you specify a value of, for example, 60
	// seconds, then the client that established the session can't call GetLatestConfiguration
	// more frequently than every 60 seconds.
	RequiredMinimumPollIntervalInSeconds *int64 `min:"15" type:"integer"`
	// contains filtered or unexported fields
}

func (StartConfigurationSessionInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartConfigurationSessionInput) SetApplicationIdentifier

SetApplicationIdentifier sets the ApplicationIdentifier field's value.

func (*StartConfigurationSessionInput) SetConfigurationProfileIdentifier

func (s *StartConfigurationSessionInput) SetConfigurationProfileIdentifier(v string) *StartConfigurationSessionInput

SetConfigurationProfileIdentifier sets the ConfigurationProfileIdentifier field's value.

func (*StartConfigurationSessionInput) SetEnvironmentIdentifier

SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value.

func (*StartConfigurationSessionInput) SetRequiredMinimumPollIntervalInSeconds

func (s *StartConfigurationSessionInput) SetRequiredMinimumPollIntervalInSeconds(v int64) *StartConfigurationSessionInput

SetRequiredMinimumPollIntervalInSeconds sets the RequiredMinimumPollIntervalInSeconds field's value.

func (StartConfigurationSessionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartConfigurationSessionInput) Validate

func (s *StartConfigurationSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartConfigurationSessionOutput

type StartConfigurationSessionOutput struct {

	// Token encapsulating state about the configuration session. Provide this token
	// to the GetLatestConfiguration API to retrieve configuration data.
	//
	// This token should only be used once in your first call to GetLatestConfiguration.
	// You must use the new token in the GetLatestConfiguration response (NextPollConfigurationToken)
	// in each subsequent call to GetLatestConfiguration.
	//
	// The InitialConfigurationToken and NextPollConfigurationToken should only
	// be used once. To support long poll use cases, the tokens are valid for up
	// to 24 hours. If a GetLatestConfiguration call uses an expired token, the
	// system returns BadRequestException.
	InitialConfigurationToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartConfigurationSessionOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartConfigurationSessionOutput) SetInitialConfigurationToken

func (s *StartConfigurationSessionOutput) SetInitialConfigurationToken(v string) *StartConfigurationSessionOutput

SetInitialConfigurationToken sets the InitialConfigurationToken field's value.

func (StartConfigurationSessionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package appconfigdataiface provides an interface to enable mocking the AWS AppConfig Data service client for testing your code.
Package appconfigdataiface provides an interface to enable mocking the AWS AppConfig Data service client for testing your code.

Jump to

Keyboard shortcuts

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