...
AWS SDK for Go API Reference
We announced the upcoming end-of-support for AWS SDK for Go (v1). We recommend that you migrate to AWS SDK for Go v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
import "github.com/aws/aws-sdk-go/service/synthetics"
Overview
Constants

Overview ▾

Package synthetics provides the client and types for making API requests to Synthetics.

You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ServiceLens.html) in the Amazon CloudWatch User Guide.

Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html).

See https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11 for more information on this service.

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

Using the Client

To contact Synthetics 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 Synthetics client Synthetics for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/synthetics/#New

The stub package, syntheticsiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type Synthetics
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Synthetics
func (c *Synthetics) AssociateResource(input *AssociateResourceInput) (*AssociateResourceOutput, error)
func (c *Synthetics) AssociateResourceRequest(input *AssociateResourceInput) (req *request.Request, output *AssociateResourceOutput)
func (c *Synthetics) AssociateResourceWithContext(ctx aws.Context, input *AssociateResourceInput, opts ...request.Option) (*AssociateResourceOutput, error)
func (c *Synthetics) CreateCanary(input *CreateCanaryInput) (*CreateCanaryOutput, error)
func (c *Synthetics) CreateCanaryRequest(input *CreateCanaryInput) (req *request.Request, output *CreateCanaryOutput)
func (c *Synthetics) CreateCanaryWithContext(ctx aws.Context, input *CreateCanaryInput, opts ...request.Option) (*CreateCanaryOutput, error)
func (c *Synthetics) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)
func (c *Synthetics) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)
func (c *Synthetics) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)
func (c *Synthetics) DeleteCanary(input *DeleteCanaryInput) (*DeleteCanaryOutput, error)
func (c *Synthetics) DeleteCanaryRequest(input *DeleteCanaryInput) (req *request.Request, output *DeleteCanaryOutput)
func (c *Synthetics) DeleteCanaryWithContext(ctx aws.Context, input *DeleteCanaryInput, opts ...request.Option) (*DeleteCanaryOutput, error)
func (c *Synthetics) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)
func (c *Synthetics) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)
func (c *Synthetics) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)
func (c *Synthetics) DescribeCanaries(input *DescribeCanariesInput) (*DescribeCanariesOutput, error)
func (c *Synthetics) DescribeCanariesLastRun(input *DescribeCanariesLastRunInput) (*DescribeCanariesLastRunOutput, error)
func (c *Synthetics) DescribeCanariesLastRunPages(input *DescribeCanariesLastRunInput, fn func(*DescribeCanariesLastRunOutput, bool) bool) error
func (c *Synthetics) DescribeCanariesLastRunPagesWithContext(ctx aws.Context, input *DescribeCanariesLastRunInput, fn func(*DescribeCanariesLastRunOutput, bool) bool, opts ...request.Option) error
func (c *Synthetics) DescribeCanariesLastRunRequest(input *DescribeCanariesLastRunInput) (req *request.Request, output *DescribeCanariesLastRunOutput)
func (c *Synthetics) DescribeCanariesLastRunWithContext(ctx aws.Context, input *DescribeCanariesLastRunInput, opts ...request.Option) (*DescribeCanariesLastRunOutput, error)
func (c *Synthetics) DescribeCanariesPages(input *DescribeCanariesInput, fn func(*DescribeCanariesOutput, bool) bool) error
func (c *Synthetics) DescribeCanariesPagesWithContext(ctx aws.Context, input *DescribeCanariesInput, fn func(*DescribeCanariesOutput, bool) bool, opts ...request.Option) error
func (c *Synthetics) DescribeCanariesRequest(input *DescribeCanariesInput) (req *request.Request, output *DescribeCanariesOutput)
func (c *Synthetics) DescribeCanariesWithContext(ctx aws.Context, input *DescribeCanariesInput, opts ...request.Option) (*DescribeCanariesOutput, error)
func (c *Synthetics) DescribeRuntimeVersions(input *DescribeRuntimeVersionsInput) (*DescribeRuntimeVersionsOutput, error)
func (c *Synthetics) DescribeRuntimeVersionsPages(input *DescribeRuntimeVersionsInput, fn func(*DescribeRuntimeVersionsOutput, bool) bool) error
func (c *Synthetics) DescribeRuntimeVersionsPagesWithContext(ctx aws.Context, input *DescribeRuntimeVersionsInput, fn func(*DescribeRuntimeVersionsOutput, bool) bool, opts ...request.Option) error
func (c *Synthetics) DescribeRuntimeVersionsRequest(input *DescribeRuntimeVersionsInput) (req *request.Request, output *DescribeRuntimeVersionsOutput)
func (c *Synthetics) DescribeRuntimeVersionsWithContext(ctx aws.Context, input *DescribeRuntimeVersionsInput, opts ...request.Option) (*DescribeRuntimeVersionsOutput, error)
func (c *Synthetics) DisassociateResource(input *DisassociateResourceInput) (*DisassociateResourceOutput, error)
func (c *Synthetics) DisassociateResourceRequest(input *DisassociateResourceInput) (req *request.Request, output *DisassociateResourceOutput)
func (c *Synthetics) DisassociateResourceWithContext(ctx aws.Context, input *DisassociateResourceInput, opts ...request.Option) (*DisassociateResourceOutput, error)
func (c *Synthetics) GetCanary(input *GetCanaryInput) (*GetCanaryOutput, error)
func (c *Synthetics) GetCanaryRequest(input *GetCanaryInput) (req *request.Request, output *GetCanaryOutput)
func (c *Synthetics) GetCanaryRuns(input *GetCanaryRunsInput) (*GetCanaryRunsOutput, error)
func (c *Synthetics) GetCanaryRunsPages(input *GetCanaryRunsInput, fn func(*GetCanaryRunsOutput, bool) bool) error
func (c *Synthetics) GetCanaryRunsPagesWithContext(ctx aws.Context, input *GetCanaryRunsInput, fn func(*GetCanaryRunsOutput, bool) bool, opts ...request.Option) error
func (c *Synthetics) GetCanaryRunsRequest(input *GetCanaryRunsInput) (req *request.Request, output *GetCanaryRunsOutput)
func (c *Synthetics) GetCanaryRunsWithContext(ctx aws.Context, input *GetCanaryRunsInput, opts ...request.Option) (*GetCanaryRunsOutput, error)
func (c *Synthetics) GetCanaryWithContext(ctx aws.Context, input *GetCanaryInput, opts ...request.Option) (*GetCanaryOutput, error)
func (c *Synthetics) GetGroup(input *GetGroupInput) (*GetGroupOutput, error)
func (c *Synthetics) GetGroupRequest(input *GetGroupInput) (req *request.Request, output *GetGroupOutput)
func (c *Synthetics) GetGroupWithContext(ctx aws.Context, input *GetGroupInput, opts ...request.Option) (*GetGroupOutput, error)
func (c *Synthetics) ListAssociatedGroups(input *ListAssociatedGroupsInput) (*ListAssociatedGroupsOutput, error)
func (c *Synthetics) ListAssociatedGroupsPages(input *ListAssociatedGroupsInput, fn func(*ListAssociatedGroupsOutput, bool) bool) error
func (c *Synthetics) ListAssociatedGroupsPagesWithContext(ctx aws.Context, input *ListAssociatedGroupsInput, fn func(*ListAssociatedGroupsOutput, bool) bool, opts ...request.Option) error
func (c *Synthetics) ListAssociatedGroupsRequest(input *ListAssociatedGroupsInput) (req *request.Request, output *ListAssociatedGroupsOutput)
func (c *Synthetics) ListAssociatedGroupsWithContext(ctx aws.Context, input *ListAssociatedGroupsInput, opts ...request.Option) (*ListAssociatedGroupsOutput, error)
func (c *Synthetics) ListGroupResources(input *ListGroupResourcesInput) (*ListGroupResourcesOutput, error)
func (c *Synthetics) ListGroupResourcesPages(input *ListGroupResourcesInput, fn func(*ListGroupResourcesOutput, bool) bool) error
func (c *Synthetics) ListGroupResourcesPagesWithContext(ctx aws.Context, input *ListGroupResourcesInput, fn func(*ListGroupResourcesOutput, bool) bool, opts ...request.Option) error
func (c *Synthetics) ListGroupResourcesRequest(input *ListGroupResourcesInput) (req *request.Request, output *ListGroupResourcesOutput)
func (c *Synthetics) ListGroupResourcesWithContext(ctx aws.Context, input *ListGroupResourcesInput, opts ...request.Option) (*ListGroupResourcesOutput, error)
func (c *Synthetics) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)
func (c *Synthetics) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error
func (c *Synthetics) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, opts ...request.Option) error
func (c *Synthetics) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)
func (c *Synthetics) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)
func (c *Synthetics) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
func (c *Synthetics) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
func (c *Synthetics) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
func (c *Synthetics) StartCanary(input *StartCanaryInput) (*StartCanaryOutput, error)
func (c *Synthetics) StartCanaryRequest(input *StartCanaryInput) (req *request.Request, output *StartCanaryOutput)
func (c *Synthetics) StartCanaryWithContext(ctx aws.Context, input *StartCanaryInput, opts ...request.Option) (*StartCanaryOutput, error)
func (c *Synthetics) StopCanary(input *StopCanaryInput) (*StopCanaryOutput, error)
func (c *Synthetics) StopCanaryRequest(input *StopCanaryInput) (req *request.Request, output *StopCanaryOutput)
func (c *Synthetics) StopCanaryWithContext(ctx aws.Context, input *StopCanaryInput, opts ...request.Option) (*StopCanaryOutput, error)
func (c *Synthetics) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
func (c *Synthetics) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
func (c *Synthetics) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
func (c *Synthetics) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
func (c *Synthetics) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
func (c *Synthetics) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
func (c *Synthetics) UpdateCanary(input *UpdateCanaryInput) (*UpdateCanaryOutput, error)
func (c *Synthetics) UpdateCanaryRequest(input *UpdateCanaryInput) (req *request.Request, output *UpdateCanaryOutput)
func (c *Synthetics) UpdateCanaryWithContext(ctx aws.Context, input *UpdateCanaryInput, opts ...request.Option) (*UpdateCanaryOutput, error)
func CanaryRunStateReasonCode_Values() []string
func CanaryRunState_Values() []string
func CanaryStateReasonCode_Values() []string
func CanaryState_Values() []string
func EncryptionMode_Values() []string
type ArtifactConfigInput_
type ArtifactConfigOutput_
type AssociateResourceInput
type AssociateResourceOutput
type BadRequestException
type BaseScreenshot
type Canary
type CanaryCodeInput
type CanaryCodeOutput
type CanaryLastRun
type CanaryRun
type CanaryRunConfigInput
type CanaryRunConfigOutput
type CanaryRunStatus
type CanaryRunTimeline
type CanaryScheduleInput
type CanaryScheduleOutput
type CanaryStatus
type CanaryTimeline
type ConflictException
type CreateCanaryInput
type CreateCanaryOutput
type CreateGroupInput
type CreateGroupOutput
type DeleteCanaryInput
type DeleteCanaryOutput
type DeleteGroupInput
type DeleteGroupOutput
type DescribeCanariesInput
type DescribeCanariesLastRunInput
type DescribeCanariesLastRunOutput
type DescribeCanariesOutput
type DescribeRuntimeVersionsInput
type DescribeRuntimeVersionsOutput
type DisassociateResourceInput
type DisassociateResourceOutput
type GetCanaryInput
type GetCanaryOutput
type GetCanaryRunsInput
type GetCanaryRunsOutput
type GetGroupInput
type GetGroupOutput
type Group
type GroupSummary
type InternalFailureException
type InternalServerException
type ListAssociatedGroupsInput
type ListAssociatedGroupsOutput
type ListGroupResourcesInput
type ListGroupResourcesOutput
type ListGroupsInput
type ListGroupsOutput
type ListTagsForResourceInput
type ListTagsForResourceOutput
type NotFoundException
type RequestEntityTooLargeException
type ResourceNotFoundException
type RuntimeVersion
type S3EncryptionConfig
type ServiceQuotaExceededException
type StartCanaryInput
type StartCanaryOutput
type StopCanaryInput
type StopCanaryOutput
type TagResourceInput
type TagResourceOutput
type TooManyRequestsException
type UntagResourceInput
type UntagResourceOutput
type UpdateCanaryInput
type UpdateCanaryOutput
type ValidationException
type VisualReferenceInput_
type VisualReferenceOutput_
type VpcConfigInput
type VpcConfigOutput

Constants ▾

const (
    // CanaryRunStateRunning is a CanaryRunState enum value
    CanaryRunStateRunning = "RUNNING"

    // CanaryRunStatePassed is a CanaryRunState enum value
    CanaryRunStatePassed = "PASSED"

    // CanaryRunStateFailed is a CanaryRunState enum value
    CanaryRunStateFailed = "FAILED"
)
const (
    // CanaryRunStateReasonCodeCanaryFailure is a CanaryRunStateReasonCode enum value
    CanaryRunStateReasonCodeCanaryFailure = "CANARY_FAILURE"

    // CanaryRunStateReasonCodeExecutionFailure is a CanaryRunStateReasonCode enum value
    CanaryRunStateReasonCodeExecutionFailure = "EXECUTION_FAILURE"
)
const (
    // CanaryStateCreating is a CanaryState enum value
    CanaryStateCreating = "CREATING"

    // CanaryStateReady is a CanaryState enum value
    CanaryStateReady = "READY"

    // CanaryStateStarting is a CanaryState enum value
    CanaryStateStarting = "STARTING"

    // CanaryStateRunning is a CanaryState enum value
    CanaryStateRunning = "RUNNING"

    // CanaryStateUpdating is a CanaryState enum value
    CanaryStateUpdating = "UPDATING"

    // CanaryStateStopping is a CanaryState enum value
    CanaryStateStopping = "STOPPING"

    // CanaryStateStopped is a CanaryState enum value
    CanaryStateStopped = "STOPPED"

    // CanaryStateError is a CanaryState enum value
    CanaryStateError = "ERROR"

    // CanaryStateDeleting is a CanaryState enum value
    CanaryStateDeleting = "DELETING"
)
const (
    // CanaryStateReasonCodeInvalidPermissions is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeInvalidPermissions = "INVALID_PERMISSIONS"

    // CanaryStateReasonCodeCreatePending is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeCreatePending = "CREATE_PENDING"

    // CanaryStateReasonCodeCreateInProgress is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeCreateInProgress = "CREATE_IN_PROGRESS"

    // CanaryStateReasonCodeCreateFailed is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeCreateFailed = "CREATE_FAILED"

    // CanaryStateReasonCodeUpdatePending is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeUpdatePending = "UPDATE_PENDING"

    // CanaryStateReasonCodeUpdateInProgress is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeUpdateInProgress = "UPDATE_IN_PROGRESS"

    // CanaryStateReasonCodeUpdateComplete is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeUpdateComplete = "UPDATE_COMPLETE"

    // CanaryStateReasonCodeRollbackComplete is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeRollbackComplete = "ROLLBACK_COMPLETE"

    // CanaryStateReasonCodeRollbackFailed is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeRollbackFailed = "ROLLBACK_FAILED"

    // CanaryStateReasonCodeDeleteInProgress is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeDeleteInProgress = "DELETE_IN_PROGRESS"

    // CanaryStateReasonCodeDeleteFailed is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeDeleteFailed = "DELETE_FAILED"

    // CanaryStateReasonCodeSyncDeleteInProgress is a CanaryStateReasonCode enum value
    CanaryStateReasonCodeSyncDeleteInProgress = "SYNC_DELETE_IN_PROGRESS"
)
const (
    // EncryptionModeSseS3 is a EncryptionMode enum value
    EncryptionModeSseS3 = "SSE_S3"

    // EncryptionModeSseKms is a EncryptionMode enum value
    EncryptionModeSseKms = "SSE_KMS"
)
const (

    // ErrCodeBadRequestException for service response error code
    // "BadRequestException".
    //
    // The request was not valid.
    ErrCodeBadRequestException = "BadRequestException"

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    //
    // A conflicting operation is already in progress.
    ErrCodeConflictException = "ConflictException"

    // ErrCodeInternalFailureException for service response error code
    // "InternalFailureException".
    //
    // An internal failure occurred. Try the operation again.
    ErrCodeInternalFailureException = "InternalFailureException"

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    //
    // An unknown internal error occurred.
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodeNotFoundException for service response error code
    // "NotFoundException".
    //
    // The specified resource was not found.
    ErrCodeNotFoundException = "NotFoundException"

    // ErrCodeRequestEntityTooLargeException for service response error code
    // "RequestEntityTooLargeException".
    //
    // One of the input resources is larger than is allowed.
    ErrCodeRequestEntityTooLargeException = "RequestEntityTooLargeException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // One of the specified resources was not found.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeServiceQuotaExceededException for service response error code
    // "ServiceQuotaExceededException".
    //
    // The request exceeded a service quota value.
    ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

    // ErrCodeTooManyRequestsException for service response error code
    // "TooManyRequestsException".
    //
    // There were too many simultaneous requests. Try the operation again.
    ErrCodeTooManyRequestsException = "TooManyRequestsException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    //
    // A parameter could not be validated.
    ErrCodeValidationException = "ValidationException"
)
const (
    ServiceName = "synthetics" // Name of service.
    EndpointsID = ServiceName  // ID to lookup a service endpoint with.
    ServiceID   = "synthetics" // ServiceID is a unique identifier of a specific service.
)

Service information constants

func CanaryRunStateReasonCode_Values

func CanaryRunStateReasonCode_Values() []string

CanaryRunStateReasonCode_Values returns all elements of the CanaryRunStateReasonCode enum

func CanaryRunState_Values

func CanaryRunState_Values() []string

CanaryRunState_Values returns all elements of the CanaryRunState enum

func CanaryStateReasonCode_Values

func CanaryStateReasonCode_Values() []string

CanaryStateReasonCode_Values returns all elements of the CanaryStateReasonCode enum

func CanaryState_Values

func CanaryState_Values() []string

CanaryState_Values returns all elements of the CanaryState enum

func EncryptionMode_Values

func EncryptionMode_Values() []string

EncryptionMode_Values returns all elements of the EncryptionMode enum

type ArtifactConfigInput_

type ArtifactConfigInput_ struct {

    // A structure that contains the configuration of the encryption-at-rest settings
    // for artifacts that the canary uploads to Amazon S3. Artifact encryption functionality
    // is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3
    // or later. For more information, see Encrypting canary artifacts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html)
    S3Encryption *S3EncryptionConfig `type:"structure"`
    // contains filtered or unexported fields
}

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

func (ArtifactConfigInput_) GoString

func (s ArtifactConfigInput_) 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 (*ArtifactConfigInput_) SetS3Encryption

func (s *ArtifactConfigInput_) SetS3Encryption(v *S3EncryptionConfig) *ArtifactConfigInput_

SetS3Encryption sets the S3Encryption field's value.

func (ArtifactConfigInput_) String

func (s ArtifactConfigInput_) 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".

func (*ArtifactConfigInput_) Validate

func (s *ArtifactConfigInput_) Validate() error

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

type ArtifactConfigOutput_

type ArtifactConfigOutput_ struct {

    // A structure that contains the configuration of encryption settings for canary
    // artifacts that are stored in Amazon S3.
    S3Encryption *S3EncryptionConfig `type:"structure"`
    // contains filtered or unexported fields
}

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

func (ArtifactConfigOutput_) GoString

func (s ArtifactConfigOutput_) 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 (*ArtifactConfigOutput_) SetS3Encryption

func (s *ArtifactConfigOutput_) SetS3Encryption(v *S3EncryptionConfig) *ArtifactConfigOutput_

SetS3Encryption sets the S3Encryption field's value.

func (ArtifactConfigOutput_) String

func (s ArtifactConfigOutput_) 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 AssociateResourceInput

type AssociateResourceInput struct {

    // Specifies the group. You can specify the group name, the ARN, or the group
    // ID as the GroupIdentifier.
    //
    // GroupIdentifier is a required field
    GroupIdentifier *string `location:"uri" locationName:"groupIdentifier" min:"1" type:"string" required:"true"`

    // The ARN of the canary that you want to associate with the specified group.
    //
    // ResourceArn is a required field
    ResourceArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (AssociateResourceInput) GoString

func (s AssociateResourceInput) 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 (*AssociateResourceInput) SetGroupIdentifier

func (s *AssociateResourceInput) SetGroupIdentifier(v string) *AssociateResourceInput

SetGroupIdentifier sets the GroupIdentifier field's value.

func (*AssociateResourceInput) SetResourceArn

func (s *AssociateResourceInput) SetResourceArn(v string) *AssociateResourceInput

SetResourceArn sets the ResourceArn field's value.

func (AssociateResourceInput) String

func (s AssociateResourceInput) 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".

func (*AssociateResourceInput) Validate

func (s *AssociateResourceInput) Validate() error

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

type AssociateResourceOutput

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

func (AssociateResourceOutput) GoString

func (s AssociateResourceOutput) 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 (AssociateResourceOutput) String

func (s AssociateResourceOutput) 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:"-"`

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

The request was not valid.

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 BaseScreenshot

type BaseScreenshot struct {

    // Coordinates that define the part of a screen to ignore during screenshot
    // comparisons. To obtain the coordinates to use here, use the CloudWatch console
    // to draw the boundaries on the screen. For more information, see Editing or
    // deleting a canary (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html)
    IgnoreCoordinates []*string `type:"list"`

    // The name of the screenshot. This is generated the first time the canary is
    // run after the UpdateCanary operation that specified for this canary to perform
    // visual monitoring.
    //
    // ScreenshotName is a required field
    ScreenshotName *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

func (BaseScreenshot) GoString

func (s BaseScreenshot) 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 (*BaseScreenshot) SetIgnoreCoordinates

func (s *BaseScreenshot) SetIgnoreCoordinates(v []*string) *BaseScreenshot

SetIgnoreCoordinates sets the IgnoreCoordinates field's value.

func (*BaseScreenshot) SetScreenshotName

func (s *BaseScreenshot) SetScreenshotName(v string) *BaseScreenshot

SetScreenshotName sets the ScreenshotName field's value.

func (BaseScreenshot) String

func (s BaseScreenshot) 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".

func (*BaseScreenshot) Validate

func (s *BaseScreenshot) Validate() error

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

type Canary

type Canary struct {

    // A structure that contains the configuration for canary artifacts, including
    // the encryption-at-rest settings for artifacts that the canary uploads to
    // Amazon S3.
    ArtifactConfig *ArtifactConfigOutput_ `type:"structure"`

    // The location in Amazon S3 where Synthetics stores artifacts from the runs
    // of this canary. Artifacts include the log file, screenshots, and HAR files.
    ArtifactS3Location *string `min:"1" type:"string"`

    // This structure contains information about the canary's Lambda handler and
    // where its code is stored by CloudWatch Synthetics.
    Code *CanaryCodeOutput `type:"structure"`

    // The ARN of the Lambda function that is used as your canary's engine. For
    // more information about Lambda ARN format, see Resources and Conditions for
    // Lambda Actions (https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html).
    EngineArn *string `min:"1" type:"string"`

    // The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com
    // as a principal in the trust policy.
    ExecutionRoleArn *string `min:"1" type:"string"`

    // The number of days to retain data about failed runs of this canary.
    FailureRetentionPeriodInDays *int64 `min:"1" type:"integer"`

    // The unique ID of this canary.
    Id *string `type:"string"`

    // The name of the canary.
    Name *string `min:"1" type:"string"`

    // A structure that contains information about a canary run.
    RunConfig *CanaryRunConfigOutput `type:"structure"`

    // Specifies the runtime version to use for the canary. For more information
    // about runtime versions, see Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).
    RuntimeVersion *string `min:"1" type:"string"`

    // A structure that contains information about how often the canary is to run,
    // and when these runs are to stop.
    Schedule *CanaryScheduleOutput `type:"structure"`

    // A structure that contains information about the canary's status.
    Status *CanaryStatus `type:"structure"`

    // The number of days to retain data about successful runs of this canary.
    SuccessRetentionPeriodInDays *int64 `min:"1" type:"integer"`

    // The list of key-value pairs that are associated with the canary.
    Tags map[string]*string `min:"1" type:"map"`

    // A structure that contains information about when the canary was created,
    // modified, and most recently run.
    Timeline *CanaryTimeline `type:"structure"`

    // If this canary performs visual monitoring by comparing screenshots, this
    // structure contains the ID of the canary run to use as the baseline for screenshots,
    // and the coordinates of any parts of the screen to ignore during the visual
    // monitoring comparison.
    VisualReference *VisualReferenceOutput_ `type:"structure"`

    // If this canary is to test an endpoint in a VPC, this structure contains information
    // about the subnets and security groups of the VPC endpoint. For more information,
    // see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).
    VpcConfig *VpcConfigOutput `type:"structure"`
    // contains filtered or unexported fields
}

This structure contains all information about one canary in your account.

func (Canary) GoString

func (s Canary) 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 (*Canary) SetArtifactConfig

func (s *Canary) SetArtifactConfig(v *ArtifactConfigOutput_) *Canary

SetArtifactConfig sets the ArtifactConfig field's value.

func (*Canary) SetArtifactS3Location

func (s *Canary) SetArtifactS3Location(v string) *Canary

SetArtifactS3Location sets the ArtifactS3Location field's value.

func (*Canary) SetCode

func (s *Canary) SetCode(v *CanaryCodeOutput) *Canary

SetCode sets the Code field's value.

func (*Canary) SetEngineArn

func (s *Canary) SetEngineArn(v string) *Canary

SetEngineArn sets the EngineArn field's value.

func (*Canary) SetExecutionRoleArn

func (s *Canary) SetExecutionRoleArn(v string) *Canary

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*Canary) SetFailureRetentionPeriodInDays

func (s *Canary) SetFailureRetentionPeriodInDays(v int64) *Canary

SetFailureRetentionPeriodInDays sets the FailureRetentionPeriodInDays field's value.

func (*Canary) SetId

func (s *Canary) SetId(v string) *Canary

SetId sets the Id field's value.

func (*Canary) SetName

func (s *Canary) SetName(v string) *Canary

SetName sets the Name field's value.

func (*Canary) SetRunConfig

func (s *Canary) SetRunConfig(v *CanaryRunConfigOutput) *Canary

SetRunConfig sets the RunConfig field's value.

func (*Canary) SetRuntimeVersion

func (s *Canary) SetRuntimeVersion(v string) *Canary

SetRuntimeVersion sets the RuntimeVersion field's value.

func (*Canary) SetSchedule

func (s *Canary) SetSchedule(v *CanaryScheduleOutput) *Canary

SetSchedule sets the Schedule field's value.

func (*Canary) SetStatus

func (s *Canary) SetStatus(v *CanaryStatus) *Canary

SetStatus sets the Status field's value.

func (*Canary) SetSuccessRetentionPeriodInDays

func (s *Canary) SetSuccessRetentionPeriodInDays(v int64) *Canary

SetSuccessRetentionPeriodInDays sets the SuccessRetentionPeriodInDays field's value.

func (*Canary) SetTags

func (s *Canary) SetTags(v map[string]*string) *Canary

SetTags sets the Tags field's value.

func (*Canary) SetTimeline

func (s *Canary) SetTimeline(v *CanaryTimeline) *Canary

SetTimeline sets the Timeline field's value.

func (*Canary) SetVisualReference

func (s *Canary) SetVisualReference(v *VisualReferenceOutput_) *Canary

SetVisualReference sets the VisualReference field's value.

func (*Canary) SetVpcConfig

func (s *Canary) SetVpcConfig(v *VpcConfigOutput) *Canary

SetVpcConfig sets the VpcConfig field's value.

func (Canary) String

func (s Canary) 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 CanaryCodeInput

type CanaryCodeInput struct {

    // The entry point to use for the source code when running the canary. For canaries
    // that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime
    // earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler.
    // For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes,
    // the handler can be specified as fileName.functionName , or you can specify
    // a folder where canary scripts reside as folder/fileName.functionName .
    //
    // Handler is a required field
    Handler *string `min:"1" type:"string" required:"true"`

    // If your canary script is located in S3, specify the bucket name here. Do
    // not include s3:// as the start of the bucket name.
    S3Bucket *string `min:"1" type:"string"`

    // The S3 key of your script. For more information, see Working with Amazon
    // S3 Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html).
    S3Key *string `min:"1" type:"string"`

    // The S3 version ID of your script.
    S3Version *string `min:"1" type:"string"`

    // If you input your canary script directly into the canary instead of referring
    // to an S3 location, the value of this parameter is the base64-encoded contents
    // of the .zip file that contains the script. It must be smaller than 225 Kb.
    //
    // For large canary scripts, we recommend that you use an S3 location instead
    // of inputting it directly with this parameter.
    // ZipFile is automatically base64 encoded/decoded by the SDK.
    ZipFile []byte `min:"1" type:"blob"`
    // contains filtered or unexported fields
}

Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.

func (CanaryCodeInput) GoString

func (s CanaryCodeInput) 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 (*CanaryCodeInput) SetHandler

func (s *CanaryCodeInput) SetHandler(v string) *CanaryCodeInput

SetHandler sets the Handler field's value.

func (*CanaryCodeInput) SetS3Bucket

func (s *CanaryCodeInput) SetS3Bucket(v string) *CanaryCodeInput

SetS3Bucket sets the S3Bucket field's value.

func (*CanaryCodeInput) SetS3Key

func (s *CanaryCodeInput) SetS3Key(v string) *CanaryCodeInput

SetS3Key sets the S3Key field's value.

func (*CanaryCodeInput) SetS3Version

func (s *CanaryCodeInput) SetS3Version(v string) *CanaryCodeInput

SetS3Version sets the S3Version field's value.

func (*CanaryCodeInput) SetZipFile

func (s *CanaryCodeInput) SetZipFile(v []byte) *CanaryCodeInput

SetZipFile sets the ZipFile field's value.

func (CanaryCodeInput) String

func (s CanaryCodeInput) 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".

func (*CanaryCodeInput) Validate

func (s *CanaryCodeInput) Validate() error

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

type CanaryCodeOutput

type CanaryCodeOutput struct {

    // The entry point to use for the source code when running the canary.
    Handler *string `min:"1" type:"string"`

    // The ARN of the Lambda layer where Synthetics stores the canary script code.
    SourceLocationArn *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.

func (CanaryCodeOutput) GoString

func (s CanaryCodeOutput) 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 (*CanaryCodeOutput) SetHandler

func (s *CanaryCodeOutput) SetHandler(v string) *CanaryCodeOutput

SetHandler sets the Handler field's value.

func (*CanaryCodeOutput) SetSourceLocationArn

func (s *CanaryCodeOutput) SetSourceLocationArn(v string) *CanaryCodeOutput

SetSourceLocationArn sets the SourceLocationArn field's value.

func (CanaryCodeOutput) String

func (s CanaryCodeOutput) 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 CanaryLastRun

type CanaryLastRun struct {

    // The name of the canary.
    CanaryName *string `min:"1" type:"string"`

    // The results from this canary's most recent run.
    LastRun *CanaryRun `type:"structure"`
    // contains filtered or unexported fields
}

This structure contains information about the most recent run of a single canary.

func (CanaryLastRun) GoString

func (s CanaryLastRun) 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 (*CanaryLastRun) SetCanaryName

func (s *CanaryLastRun) SetCanaryName(v string) *CanaryLastRun

SetCanaryName sets the CanaryName field's value.

func (*CanaryLastRun) SetLastRun

func (s *CanaryLastRun) SetLastRun(v *CanaryRun) *CanaryLastRun

SetLastRun sets the LastRun field's value.

func (CanaryLastRun) String

func (s CanaryLastRun) 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 CanaryRun

type CanaryRun struct {

    // The location where the canary stored artifacts from the run. Artifacts include
    // the log file, screenshots, and HAR files.
    ArtifactS3Location *string `min:"1" type:"string"`

    // A unique ID that identifies this canary run.
    Id *string `type:"string"`

    // The name of the canary.
    Name *string `min:"1" type:"string"`

    // The status of this run.
    Status *CanaryRunStatus `type:"structure"`

    // A structure that contains the start and end times of this run.
    Timeline *CanaryRunTimeline `type:"structure"`
    // contains filtered or unexported fields
}

This structure contains the details about one run of one canary.

func (CanaryRun) GoString

func (s CanaryRun) 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 (*CanaryRun) SetArtifactS3Location

func (s *CanaryRun) SetArtifactS3Location(v string) *CanaryRun

SetArtifactS3Location sets the ArtifactS3Location field's value.

func (*CanaryRun) SetId

func (s *CanaryRun) SetId(v string) *CanaryRun

SetId sets the Id field's value.

func (*CanaryRun) SetName

func (s *CanaryRun) SetName(v string) *CanaryRun

SetName sets the Name field's value.

func (*CanaryRun) SetStatus

func (s *CanaryRun) SetStatus(v *CanaryRunStatus) *CanaryRun

SetStatus sets the Status field's value.

func (*CanaryRun) SetTimeline

func (s *CanaryRun) SetTimeline(v *CanaryRunTimeline) *CanaryRun

SetTimeline sets the Timeline field's value.

func (CanaryRun) String

func (s CanaryRun) 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 CanaryRunConfigInput

type CanaryRunConfigInput struct {

    // Specifies whether this canary is to use active X-Ray tracing when it runs.
    // Active tracing enables this canary run to be displayed in the ServiceLens
    // and X-Ray service maps even if the canary does not hit an endpoint that has
    // X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information,
    // see Canaries and X-Ray tracing (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html).
    //
    // You can enable active tracing only for canaries that use version syn-nodejs-2.0
    // or later for their canary runtime.
    ActiveTracing *bool `type:"boolean"`

    // Specifies the keys and values to use for any environment variables used in
    // the canary script. Use the following format:
    //
    // { "key1" : "value1", "key2" : "value2", ...}
    //
    // Keys must start with a letter and be at least two characters. The total size
    // of your environment variables cannot exceed 4 KB. You can't specify any Lambda
    // reserved environment variables as the keys for your environment variables.
    // For more information about reserved keys, see Runtime environment variables
    // (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime).
    //
    // The environment variables keys and values are not encrypted. Do not store
    // sensitive information in this field.
    EnvironmentVariables map[string]*string `type:"map"`

    // The maximum amount of memory available to the canary while it is running,
    // in MB. This value must be a multiple of 64.
    MemoryInMB *int64 `min:"960" type:"integer"`

    // How long the canary is allowed to run before it must stop. You can't set
    // this time to be longer than the frequency of the runs of this canary.
    //
    // If you omit this field, the frequency of the canary is used as this value,
    // up to a maximum of 14 minutes.
    TimeoutInSeconds *int64 `min:"3" type:"integer"`
    // contains filtered or unexported fields
}

A structure that contains input information for a canary run.

func (CanaryRunConfigInput) GoString

func (s CanaryRunConfigInput) 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 (*CanaryRunConfigInput) SetActiveTracing

func (s *CanaryRunConfigInput) SetActiveTracing(v bool) *CanaryRunConfigInput

SetActiveTracing sets the ActiveTracing field's value.

func (*CanaryRunConfigInput) SetEnvironmentVariables

func (s *CanaryRunConfigInput) SetEnvironmentVariables(v map[string]*string) *CanaryRunConfigInput

SetEnvironmentVariables sets the EnvironmentVariables field's value.

func (*CanaryRunConfigInput) SetMemoryInMB

func (s *CanaryRunConfigInput) SetMemoryInMB(v int64) *CanaryRunConfigInput

SetMemoryInMB sets the MemoryInMB field's value.

func (*CanaryRunConfigInput) SetTimeoutInSeconds

func (s *CanaryRunConfigInput) SetTimeoutInSeconds(v int64) *CanaryRunConfigInput

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (CanaryRunConfigInput) String

func (s CanaryRunConfigInput) 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".

func (*CanaryRunConfigInput) Validate

func (s *CanaryRunConfigInput) Validate() error

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

type CanaryRunConfigOutput

type CanaryRunConfigOutput struct {

    // Displays whether this canary run used active X-Ray tracing.
    ActiveTracing *bool `type:"boolean"`

    // The maximum amount of memory available to the canary while it is running,
    // in MB. This value must be a multiple of 64.
    MemoryInMB *int64 `min:"960" type:"integer"`

    // How long the canary is allowed to run before it must stop.
    TimeoutInSeconds *int64 `min:"3" type:"integer"`
    // contains filtered or unexported fields
}

A structure that contains information about a canary run.

func (CanaryRunConfigOutput) GoString

func (s CanaryRunConfigOutput) 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 (*CanaryRunConfigOutput) SetActiveTracing

func (s *CanaryRunConfigOutput) SetActiveTracing(v bool) *CanaryRunConfigOutput

SetActiveTracing sets the ActiveTracing field's value.

func (*CanaryRunConfigOutput) SetMemoryInMB

func (s *CanaryRunConfigOutput) SetMemoryInMB(v int64) *CanaryRunConfigOutput

SetMemoryInMB sets the MemoryInMB field's value.

func (*CanaryRunConfigOutput) SetTimeoutInSeconds

func (s *CanaryRunConfigOutput) SetTimeoutInSeconds(v int64) *CanaryRunConfigOutput

SetTimeoutInSeconds sets the TimeoutInSeconds field's value.

func (CanaryRunConfigOutput) String

func (s CanaryRunConfigOutput) 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 CanaryRunStatus

type CanaryRunStatus struct {

    // The current state of the run.
    State *string `type:"string" enum:"CanaryRunState"`

    // If run of the canary failed, this field contains the reason for the error.
    StateReason *string `min:"1" type:"string"`

    // If this value is CANARY_FAILURE, an exception occurred in the canary code.
    // If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.
    StateReasonCode *string `type:"string" enum:"CanaryRunStateReasonCode"`
    // contains filtered or unexported fields
}

This structure contains the status information about a canary run.

func (CanaryRunStatus) GoString

func (s CanaryRunStatus) 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 (*CanaryRunStatus) SetState

func (s *CanaryRunStatus) SetState(v string) *CanaryRunStatus

SetState sets the State field's value.

func (*CanaryRunStatus) SetStateReason

func (s *CanaryRunStatus) SetStateReason(v string) *CanaryRunStatus

SetStateReason sets the StateReason field's value.

func (*CanaryRunStatus) SetStateReasonCode

func (s *CanaryRunStatus) SetStateReasonCode(v string) *CanaryRunStatus

SetStateReasonCode sets the StateReasonCode field's value.

func (CanaryRunStatus) String

func (s CanaryRunStatus) 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 CanaryRunTimeline

type CanaryRunTimeline struct {

    // The end time of the run.
    Completed *time.Time `type:"timestamp"`

    // The start time of the run.
    Started *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

This structure contains the start and end times of a single canary run.

func (CanaryRunTimeline) GoString

func (s CanaryRunTimeline) 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 (*CanaryRunTimeline) SetCompleted

func (s *CanaryRunTimeline) SetCompleted(v time.Time) *CanaryRunTimeline

SetCompleted sets the Completed field's value.

func (*CanaryRunTimeline) SetStarted

func (s *CanaryRunTimeline) SetStarted(v time.Time) *CanaryRunTimeline

SetStarted sets the Started field's value.

func (CanaryRunTimeline) String

func (s CanaryRunTimeline) 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 CanaryScheduleInput

type CanaryScheduleInput struct {

    // How long, in seconds, for the canary to continue making regular runs according
    // to the schedule in the Expression value. If you specify 0, the canary continues
    // making runs until you stop it. If you omit this field, the default of 0 is
    // used.
    DurationInSeconds *int64 `type:"long"`

    // A rate expression or a cron expression that defines how often the canary
    // is to run.
    //
    // For a rate expression, The syntax is rate(number unit). unit can be minute,
    // minutes, or hour.
    //
    // For example, rate(1 minute) runs the canary once a minute, rate(10 minutes)
    // runs it once every 10 minutes, and rate(1 hour) runs it once every hour.
    // You can specify a frequency between rate(1 minute) and rate(1 hour).
    //
    // Specifying rate(0 minute) or rate(0 hour) is a special value that causes
    // the canary to run only once when it is started.
    //
    // Use cron(expression) to specify a cron expression. You can't schedule a canary
    // to wait for more than a year before running. For information about the syntax
    // for cron expressions, see Scheduling canary runs using cron (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).
    //
    // Expression is a required field
    Expression *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.

func (CanaryScheduleInput) GoString

func (s CanaryScheduleInput) 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 (*CanaryScheduleInput) SetDurationInSeconds

func (s *CanaryScheduleInput) SetDurationInSeconds(v int64) *CanaryScheduleInput

SetDurationInSeconds sets the DurationInSeconds field's value.

func (*CanaryScheduleInput) SetExpression

func (s *CanaryScheduleInput) SetExpression(v string) *CanaryScheduleInput

SetExpression sets the Expression field's value.

func (CanaryScheduleInput) String

func (s CanaryScheduleInput) 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".

func (*CanaryScheduleInput) Validate

func (s *CanaryScheduleInput) Validate() error

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

type CanaryScheduleOutput

type CanaryScheduleOutput struct {

    // How long, in seconds, for the canary to continue making regular runs after
    // it was created. The runs are performed according to the schedule in the Expression
    // value.
    DurationInSeconds *int64 `type:"long"`

    // A rate expression or a cron expression that defines how often the canary
    // is to run.
    //
    // For a rate expression, The syntax is rate(number unit). unit can be minute,
    // minutes, or hour.
    //
    // For example, rate(1 minute) runs the canary once a minute, rate(10 minutes)
    // runs it once every 10 minutes, and rate(1 hour) runs it once every hour.
    // You can specify a frequency between rate(1 minute) and rate(1 hour).
    //
    // Specifying rate(0 minute) or rate(0 hour) is a special value that causes
    // the canary to run only once when it is started.
    //
    // Use cron(expression) to specify a cron expression. For information about
    // the syntax for cron expressions, see Scheduling canary runs using cron (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html).
    Expression *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

func (CanaryScheduleOutput) GoString

func (s CanaryScheduleOutput) 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 (*CanaryScheduleOutput) SetDurationInSeconds

func (s *CanaryScheduleOutput) SetDurationInSeconds(v int64) *CanaryScheduleOutput

SetDurationInSeconds sets the DurationInSeconds field's value.

func (*CanaryScheduleOutput) SetExpression

func (s *CanaryScheduleOutput) SetExpression(v string) *CanaryScheduleOutput

SetExpression sets the Expression field's value.

func (CanaryScheduleOutput) String

func (s CanaryScheduleOutput) 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 CanaryStatus

type CanaryStatus struct {

    // The current state of the canary.
    State *string `type:"string" enum:"CanaryState"`

    // If the canary has insufficient permissions to run, this field provides more
    // details.
    StateReason *string `min:"1" type:"string"`

    // If the canary cannot run or has failed, this field displays the reason.
    StateReasonCode *string `type:"string" enum:"CanaryStateReasonCode"`
    // contains filtered or unexported fields
}

A structure that contains the current state of the canary.

func (CanaryStatus) GoString

func (s CanaryStatus) 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 (*CanaryStatus) SetState

func (s *CanaryStatus) SetState(v string) *CanaryStatus

SetState sets the State field's value.

func (*CanaryStatus) SetStateReason

func (s *CanaryStatus) SetStateReason(v string) *CanaryStatus

SetStateReason sets the StateReason field's value.

func (*CanaryStatus) SetStateReasonCode

func (s *CanaryStatus) SetStateReasonCode(v string) *CanaryStatus

SetStateReasonCode sets the StateReasonCode field's value.

func (CanaryStatus) String

func (s CanaryStatus) 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 CanaryTimeline

type CanaryTimeline struct {

    // The date and time the canary was created.
    Created *time.Time `type:"timestamp"`

    // The date and time the canary was most recently modified.
    LastModified *time.Time `type:"timestamp"`

    // The date and time that the canary's most recent run started.
    LastStarted *time.Time `type:"timestamp"`

    // The date and time that the canary's most recent run ended.
    LastStopped *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

This structure contains information about when the canary was created and modified.

func (CanaryTimeline) GoString

func (s CanaryTimeline) 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 (*CanaryTimeline) SetCreated

func (s *CanaryTimeline) SetCreated(v time.Time) *CanaryTimeline

SetCreated sets the Created field's value.

func (*CanaryTimeline) SetLastModified

func (s *CanaryTimeline) SetLastModified(v time.Time) *CanaryTimeline

SetLastModified sets the LastModified field's value.

func (*CanaryTimeline) SetLastStarted

func (s *CanaryTimeline) SetLastStarted(v time.Time) *CanaryTimeline

SetLastStarted sets the LastStarted field's value.

func (*CanaryTimeline) SetLastStopped

func (s *CanaryTimeline) SetLastStopped(v time.Time) *CanaryTimeline

SetLastStopped sets the LastStopped field's value.

func (CanaryTimeline) String

func (s CanaryTimeline) 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 ConflictException

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

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

A conflicting operation is already in progress.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) 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 (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String

func (s ConflictException) 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 CreateCanaryInput

type CreateCanaryInput struct {

    // A structure that contains the configuration for canary artifacts, including
    // the encryption-at-rest settings for artifacts that the canary uploads to
    // Amazon S3.
    ArtifactConfig *ArtifactConfigInput_ `type:"structure"`

    // The location in Amazon S3 where Synthetics stores artifacts from the test
    // runs of this canary. Artifacts include the log file, screenshots, and HAR
    // files. The name of the S3 bucket can't include a period (.).
    //
    // ArtifactS3Location is a required field
    ArtifactS3Location *string `min:"1" type:"string" required:"true"`

    // A structure that includes the entry point from which the canary should start
    // running your script. If the script is stored in an S3 bucket, the bucket
    // name, key, and version are also included.
    //
    // Code is a required field
    Code *CanaryCodeInput `type:"structure" required:"true"`

    // The ARN of the IAM role to be used to run the canary. This role must already
    // exist, and must include lambda.amazonaws.com as a principal in the trust
    // policy. The role must also have the following permissions:
    //
    //    * s3:PutObject
    //
    //    * s3:GetBucketLocation
    //
    //    * s3:ListAllMyBuckets
    //
    //    * cloudwatch:PutMetricData
    //
    //    * logs:CreateLogGroup
    //
    //    * logs:CreateLogStream
    //
    //    * logs:PutLogEvents
    //
    // ExecutionRoleArn is a required field
    ExecutionRoleArn *string `min:"1" type:"string" required:"true"`

    // The number of days to retain data about failed runs of this canary. If you
    // omit this field, the default of 31 days is used. The valid range is 1 to
    // 455 days.
    FailureRetentionPeriodInDays *int64 `min:"1" type:"integer"`

    // The name for this canary. Be sure to give it a descriptive name that distinguishes
    // it from other canaries in your account.
    //
    // Do not include secrets or proprietary information in your canary names. The
    // canary name makes up part of the canary ARN, and the ARN is included in outbound
    // calls over the internet. For more information, see Security Considerations
    // for Synthetics Canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html).
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // A structure that contains the configuration for individual canary runs, such
    // as timeout value and environment variables.
    //
    // The environment variables keys and values are not encrypted. Do not store
    // sensitive information in this field.
    RunConfig *CanaryRunConfigInput `type:"structure"`

    // Specifies the runtime version to use for the canary. For a list of valid
    // runtime versions and more information about runtime versions, see Canary
    // Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).
    //
    // RuntimeVersion is a required field
    RuntimeVersion *string `min:"1" type:"string" required:"true"`

    // A structure that contains information about how often the canary is to run
    // and when these test runs are to stop.
    //
    // Schedule is a required field
    Schedule *CanaryScheduleInput `type:"structure" required:"true"`

    // The number of days to retain data about successful runs of this canary. If
    // you omit this field, the default of 31 days is used. The valid range is 1
    // to 455 days.
    SuccessRetentionPeriodInDays *int64 `min:"1" type:"integer"`

    // A list of key-value pairs to associate with the canary. You can associate
    // as many as 50 tags with a canary.
    //
    // Tags can help you organize and categorize your resources. You can also use
    // them to scope user permissions, by granting a user permission to access or
    // change only the resources that have certain tag values.
    Tags map[string]*string `min:"1" type:"map"`

    // If this canary is to test an endpoint in a VPC, this structure contains information
    // about the subnet and security groups of the VPC endpoint. For more information,
    // see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).
    VpcConfig *VpcConfigInput `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateCanaryInput) GoString

func (s CreateCanaryInput) 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 (*CreateCanaryInput) SetArtifactConfig

func (s *CreateCanaryInput) SetArtifactConfig(v *ArtifactConfigInput_) *CreateCanaryInput

SetArtifactConfig sets the ArtifactConfig field's value.

func (*CreateCanaryInput) SetArtifactS3Location

func (s *CreateCanaryInput) SetArtifactS3Location(v string) *CreateCanaryInput

SetArtifactS3Location sets the ArtifactS3Location field's value.

func (*CreateCanaryInput) SetCode

func (s *CreateCanaryInput) SetCode(v *CanaryCodeInput) *CreateCanaryInput

SetCode sets the Code field's value.

func (*CreateCanaryInput) SetExecutionRoleArn

func (s *CreateCanaryInput) SetExecutionRoleArn(v string) *CreateCanaryInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*CreateCanaryInput) SetFailureRetentionPeriodInDays

func (s *CreateCanaryInput) SetFailureRetentionPeriodInDays(v int64) *CreateCanaryInput

SetFailureRetentionPeriodInDays sets the FailureRetentionPeriodInDays field's value.

func (*CreateCanaryInput) SetName

func (s *CreateCanaryInput) SetName(v string) *CreateCanaryInput

SetName sets the Name field's value.

func (*CreateCanaryInput) SetRunConfig

func (s *CreateCanaryInput) SetRunConfig(v *CanaryRunConfigInput) *CreateCanaryInput

SetRunConfig sets the RunConfig field's value.

func (*CreateCanaryInput) SetRuntimeVersion

func (s *CreateCanaryInput) SetRuntimeVersion(v string) *CreateCanaryInput

SetRuntimeVersion sets the RuntimeVersion field's value.

func (*CreateCanaryInput) SetSchedule

func (s *CreateCanaryInput) SetSchedule(v *CanaryScheduleInput) *CreateCanaryInput

SetSchedule sets the Schedule field's value.

func (*CreateCanaryInput) SetSuccessRetentionPeriodInDays

func (s *CreateCanaryInput) SetSuccessRetentionPeriodInDays(v int64) *CreateCanaryInput

SetSuccessRetentionPeriodInDays sets the SuccessRetentionPeriodInDays field's value.

func (*CreateCanaryInput) SetTags

func (s *CreateCanaryInput) SetTags(v map[string]*string) *CreateCanaryInput

SetTags sets the Tags field's value.

func (*CreateCanaryInput) SetVpcConfig

func (s *CreateCanaryInput) SetVpcConfig(v *VpcConfigInput) *CreateCanaryInput

SetVpcConfig sets the VpcConfig field's value.

func (CreateCanaryInput) String

func (s CreateCanaryInput) 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".

func (*CreateCanaryInput) Validate

func (s *CreateCanaryInput) Validate() error

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

type CreateCanaryOutput

type CreateCanaryOutput struct {

    // The full details about the canary you have created.
    Canary *Canary `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateCanaryOutput) GoString

func (s CreateCanaryOutput) 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 (*CreateCanaryOutput) SetCanary

func (s *CreateCanaryOutput) SetCanary(v *Canary) *CreateCanaryOutput

SetCanary sets the Canary field's value.

func (CreateCanaryOutput) String

func (s CreateCanaryOutput) 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 CreateGroupInput

type CreateGroupInput struct {

    // The name for the group. It can include any Unicode characters.
    //
    // The names for all groups in your account, across all Regions, must be unique.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // A list of key-value pairs to associate with the group. You can associate
    // as many as 50 tags with a group.
    //
    // Tags can help you organize and categorize your resources. You can also use
    // them to scope user permissions, by granting a user permission to access or
    // change only the resources that have certain tag values.
    Tags map[string]*string `min:"1" type:"map"`
    // contains filtered or unexported fields
}

func (CreateGroupInput) GoString

func (s CreateGroupInput) 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 (*CreateGroupInput) SetName

func (s *CreateGroupInput) SetName(v string) *CreateGroupInput

SetName sets the Name field's value.

func (*CreateGroupInput) SetTags

func (s *CreateGroupInput) SetTags(v map[string]*string) *CreateGroupInput

SetTags sets the Tags field's value.

func (CreateGroupInput) String

func (s CreateGroupInput) 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".

func (*CreateGroupInput) Validate

func (s *CreateGroupInput) Validate() error

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

type CreateGroupOutput

type CreateGroupOutput struct {

    // A structure that contains information about the group that was just created.
    Group *Group `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateGroupOutput) GoString

func (s CreateGroupOutput) 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 (*CreateGroupOutput) SetGroup

func (s *CreateGroupOutput) SetGroup(v *Group) *CreateGroupOutput

SetGroup sets the Group field's value.

func (CreateGroupOutput) String

func (s CreateGroupOutput) 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 DeleteCanaryInput

type DeleteCanaryInput struct {

    // Specifies whether to also delete the Lambda functions and layers used by
    // this canary. The default is false.
    //
    // Type: Boolean
    DeleteLambda *bool `location:"querystring" locationName:"deleteLambda" type:"boolean"`

    // The name of the canary that you want to delete. To find the names of your
    // canaries, use DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html).
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteCanaryInput) GoString

func (s DeleteCanaryInput) 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 (*DeleteCanaryInput) SetDeleteLambda

func (s *DeleteCanaryInput) SetDeleteLambda(v bool) *DeleteCanaryInput

SetDeleteLambda sets the DeleteLambda field's value.

func (*DeleteCanaryInput) SetName

func (s *DeleteCanaryInput) SetName(v string) *DeleteCanaryInput

SetName sets the Name field's value.

func (DeleteCanaryInput) String

func (s DeleteCanaryInput) 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".

func (*DeleteCanaryInput) Validate

func (s *DeleteCanaryInput) Validate() error

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

type DeleteCanaryOutput

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

func (DeleteCanaryOutput) GoString

func (s DeleteCanaryOutput) 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 (DeleteCanaryOutput) String

func (s DeleteCanaryOutput) 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 DeleteGroupInput

type DeleteGroupInput struct {

    // Specifies which group to delete. You can specify the group name, the ARN,
    // or the group ID as the GroupIdentifier.
    //
    // GroupIdentifier is a required field
    GroupIdentifier *string `location:"uri" locationName:"groupIdentifier" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteGroupInput) GoString

func (s DeleteGroupInput) 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 (*DeleteGroupInput) SetGroupIdentifier

func (s *DeleteGroupInput) SetGroupIdentifier(v string) *DeleteGroupInput

SetGroupIdentifier sets the GroupIdentifier field's value.

func (DeleteGroupInput) String

func (s DeleteGroupInput) 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".

func (*DeleteGroupInput) Validate

func (s *DeleteGroupInput) Validate() error

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

type DeleteGroupOutput

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

func (DeleteGroupOutput) GoString

func (s DeleteGroupOutput) 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 (DeleteGroupOutput) String

func (s DeleteGroupOutput) 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 DescribeCanariesInput

type DescribeCanariesInput struct {

    // Specify this parameter to limit how many canaries are returned each time
    // you use the DescribeCanaries operation. If you omit this parameter, the default
    // of 100 is used.
    MaxResults *int64 `min:"1" type:"integer"`

    // Use this parameter to return only canaries that match the names that you
    // specify here. You can specify as many as five canary names.
    //
    // If you specify this parameter, the operation is successful only if you have
    // authorization to view all the canaries that you specify in your request.
    // If you do not have permission to view any of the canaries, the request fails
    // with a 403 response.
    //
    // You are required to use this parameter if you are logged on to a user or
    // role that has an IAM policy that restricts which canaries that you are allowed
    // to view. For more information, see Limiting a user to viewing specific canaries
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html).
    Names []*string `min:"1" type:"list"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent operation to retrieve the next set of results.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeCanariesInput) GoString

func (s DescribeCanariesInput) 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 (*DescribeCanariesInput) SetMaxResults

func (s *DescribeCanariesInput) SetMaxResults(v int64) *DescribeCanariesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeCanariesInput) SetNames

func (s *DescribeCanariesInput) SetNames(v []*string) *DescribeCanariesInput

SetNames sets the Names field's value.

func (*DescribeCanariesInput) SetNextToken

func (s *DescribeCanariesInput) SetNextToken(v string) *DescribeCanariesInput

SetNextToken sets the NextToken field's value.

func (DescribeCanariesInput) String

func (s DescribeCanariesInput) 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".

func (*DescribeCanariesInput) Validate

func (s *DescribeCanariesInput) Validate() error

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

type DescribeCanariesLastRunInput

type DescribeCanariesLastRunInput struct {

    // Specify this parameter to limit how many runs are returned each time you
    // use the DescribeLastRun operation. If you omit this parameter, the default
    // of 100 is used.
    MaxResults *int64 `min:"1" type:"integer"`

    // Use this parameter to return only canaries that match the names that you
    // specify here. You can specify as many as five canary names.
    //
    // If you specify this parameter, the operation is successful only if you have
    // authorization to view all the canaries that you specify in your request.
    // If you do not have permission to view any of the canaries, the request fails
    // with a 403 response.
    //
    // You are required to use the Names parameter if you are logged on to a user
    // or role that has an IAM policy that restricts which canaries that you are
    // allowed to view. For more information, see Limiting a user to viewing specific
    // canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html).
    Names []*string `min:"1" type:"list"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent DescribeCanariesLastRun operation to retrieve the next
    // set of results.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeCanariesLastRunInput) GoString

func (s DescribeCanariesLastRunInput) 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 (*DescribeCanariesLastRunInput) SetMaxResults

func (s *DescribeCanariesLastRunInput) SetMaxResults(v int64) *DescribeCanariesLastRunInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeCanariesLastRunInput) SetNames

func (s *DescribeCanariesLastRunInput) SetNames(v []*string) *DescribeCanariesLastRunInput

SetNames sets the Names field's value.

func (*DescribeCanariesLastRunInput) SetNextToken

func (s *DescribeCanariesLastRunInput) SetNextToken(v string) *DescribeCanariesLastRunInput

SetNextToken sets the NextToken field's value.

func (DescribeCanariesLastRunInput) String

func (s DescribeCanariesLastRunInput) 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".

func (*DescribeCanariesLastRunInput) Validate

func (s *DescribeCanariesLastRunInput) Validate() error

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

type DescribeCanariesLastRunOutput

type DescribeCanariesLastRunOutput struct {

    // An array that contains the information from the most recent run of each canary.
    CanariesLastRun []*CanaryLastRun `type:"list"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent DescribeCanariesLastRun operation to retrieve the next
    // set of results.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeCanariesLastRunOutput) GoString

func (s DescribeCanariesLastRunOutput) 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 (*DescribeCanariesLastRunOutput) SetCanariesLastRun

func (s *DescribeCanariesLastRunOutput) SetCanariesLastRun(v []*CanaryLastRun) *DescribeCanariesLastRunOutput

SetCanariesLastRun sets the CanariesLastRun field's value.

func (*DescribeCanariesLastRunOutput) SetNextToken

func (s *DescribeCanariesLastRunOutput) SetNextToken(v string) *DescribeCanariesLastRunOutput

SetNextToken sets the NextToken field's value.

func (DescribeCanariesLastRunOutput) String

func (s DescribeCanariesLastRunOutput) 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 DescribeCanariesOutput

type DescribeCanariesOutput struct {

    // Returns an array. Each item in the array contains the full information about
    // one canary.
    Canaries []*Canary `type:"list"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent DescribeCanaries operation to retrieve the next set
    // of results.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeCanariesOutput) GoString

func (s DescribeCanariesOutput) 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 (*DescribeCanariesOutput) SetCanaries

func (s *DescribeCanariesOutput) SetCanaries(v []*Canary) *DescribeCanariesOutput

SetCanaries sets the Canaries field's value.

func (*DescribeCanariesOutput) SetNextToken

func (s *DescribeCanariesOutput) SetNextToken(v string) *DescribeCanariesOutput

SetNextToken sets the NextToken field's value.

func (DescribeCanariesOutput) String

func (s DescribeCanariesOutput) 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 DescribeRuntimeVersionsInput

type DescribeRuntimeVersionsInput struct {

    // Specify this parameter to limit how many runs are returned each time you
    // use the DescribeRuntimeVersions operation. If you omit this parameter, the
    // default of 100 is used.
    MaxResults *int64 `min:"1" type:"integer"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent DescribeRuntimeVersions operation to retrieve the next
    // set of results.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeRuntimeVersionsInput) GoString

func (s DescribeRuntimeVersionsInput) 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 (*DescribeRuntimeVersionsInput) SetMaxResults

func (s *DescribeRuntimeVersionsInput) SetMaxResults(v int64) *DescribeRuntimeVersionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeRuntimeVersionsInput) SetNextToken

func (s *DescribeRuntimeVersionsInput) SetNextToken(v string) *DescribeRuntimeVersionsInput

SetNextToken sets the NextToken field's value.

func (DescribeRuntimeVersionsInput) String

func (s DescribeRuntimeVersionsInput) 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".

func (*DescribeRuntimeVersionsInput) Validate

func (s *DescribeRuntimeVersionsInput) Validate() error

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

type DescribeRuntimeVersionsOutput

type DescribeRuntimeVersionsOutput struct {

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent DescribeRuntimeVersions operation to retrieve the next
    // set of results.
    NextToken *string `min:"4" type:"string"`

    // An array of objects that display the details about each Synthetics canary
    // runtime version.
    RuntimeVersions []*RuntimeVersion `type:"list"`
    // contains filtered or unexported fields
}

func (DescribeRuntimeVersionsOutput) GoString

func (s DescribeRuntimeVersionsOutput) 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 (*DescribeRuntimeVersionsOutput) SetNextToken

func (s *DescribeRuntimeVersionsOutput) SetNextToken(v string) *DescribeRuntimeVersionsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeRuntimeVersionsOutput) SetRuntimeVersions

func (s *DescribeRuntimeVersionsOutput) SetRuntimeVersions(v []*RuntimeVersion) *DescribeRuntimeVersionsOutput

SetRuntimeVersions sets the RuntimeVersions field's value.

func (DescribeRuntimeVersionsOutput) String

func (s DescribeRuntimeVersionsOutput) 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 DisassociateResourceInput

type DisassociateResourceInput struct {

    // Specifies the group. You can specify the group name, the ARN, or the group
    // ID as the GroupIdentifier.
    //
    // GroupIdentifier is a required field
    GroupIdentifier *string `location:"uri" locationName:"groupIdentifier" min:"1" type:"string" required:"true"`

    // The ARN of the canary that you want to remove from the specified group.
    //
    // ResourceArn is a required field
    ResourceArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DisassociateResourceInput) GoString

func (s DisassociateResourceInput) 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 (*DisassociateResourceInput) SetGroupIdentifier

func (s *DisassociateResourceInput) SetGroupIdentifier(v string) *DisassociateResourceInput

SetGroupIdentifier sets the GroupIdentifier field's value.

func (*DisassociateResourceInput) SetResourceArn

func (s *DisassociateResourceInput) SetResourceArn(v string) *DisassociateResourceInput

SetResourceArn sets the ResourceArn field's value.

func (DisassociateResourceInput) String

func (s DisassociateResourceInput) 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".

func (*DisassociateResourceInput) Validate

func (s *DisassociateResourceInput) Validate() error

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

type DisassociateResourceOutput

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

func (DisassociateResourceOutput) GoString

func (s DisassociateResourceOutput) 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 (DisassociateResourceOutput) String

func (s DisassociateResourceOutput) 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 GetCanaryInput

type GetCanaryInput struct {

    // The name of the canary that you want details for.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetCanaryInput) GoString

func (s GetCanaryInput) 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 (*GetCanaryInput) SetName

func (s *GetCanaryInput) SetName(v string) *GetCanaryInput

SetName sets the Name field's value.

func (GetCanaryInput) String

func (s GetCanaryInput) 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".

func (*GetCanaryInput) Validate

func (s *GetCanaryInput) Validate() error

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

type GetCanaryOutput

type GetCanaryOutput struct {

    // A structure that contains the full information about the canary.
    Canary *Canary `type:"structure"`
    // contains filtered or unexported fields
}

func (GetCanaryOutput) GoString

func (s GetCanaryOutput) 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 (*GetCanaryOutput) SetCanary

func (s *GetCanaryOutput) SetCanary(v *Canary) *GetCanaryOutput

SetCanary sets the Canary field's value.

func (GetCanaryOutput) String

func (s GetCanaryOutput) 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 GetCanaryRunsInput

type GetCanaryRunsInput struct {

    // Specify this parameter to limit how many runs are returned each time you
    // use the GetCanaryRuns operation. If you omit this parameter, the default
    // of 100 is used.
    MaxResults *int64 `min:"1" type:"integer"`

    // The name of the canary that you want to see runs for.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent GetCanaryRuns operation to retrieve the next set of
    // results.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (GetCanaryRunsInput) GoString

func (s GetCanaryRunsInput) 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 (*GetCanaryRunsInput) SetMaxResults

func (s *GetCanaryRunsInput) SetMaxResults(v int64) *GetCanaryRunsInput

SetMaxResults sets the MaxResults field's value.

func (*GetCanaryRunsInput) SetName

func (s *GetCanaryRunsInput) SetName(v string) *GetCanaryRunsInput

SetName sets the Name field's value.

func (*GetCanaryRunsInput) SetNextToken

func (s *GetCanaryRunsInput) SetNextToken(v string) *GetCanaryRunsInput

SetNextToken sets the NextToken field's value.

func (GetCanaryRunsInput) String

func (s GetCanaryRunsInput) 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".

func (*GetCanaryRunsInput) Validate

func (s *GetCanaryRunsInput) Validate() error

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

type GetCanaryRunsOutput

type GetCanaryRunsOutput struct {

    // An array of structures. Each structure contains the details of one of the
    // retrieved canary runs.
    CanaryRuns []*CanaryRun `type:"list"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent GetCanaryRuns operation to retrieve the next set of
    // results.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (GetCanaryRunsOutput) GoString

func (s GetCanaryRunsOutput) 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 (*GetCanaryRunsOutput) SetCanaryRuns

func (s *GetCanaryRunsOutput) SetCanaryRuns(v []*CanaryRun) *GetCanaryRunsOutput

SetCanaryRuns sets the CanaryRuns field's value.

func (*GetCanaryRunsOutput) SetNextToken

func (s *GetCanaryRunsOutput) SetNextToken(v string) *GetCanaryRunsOutput

SetNextToken sets the NextToken field's value.

func (GetCanaryRunsOutput) String

func (s GetCanaryRunsOutput) 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 GetGroupInput

type GetGroupInput struct {

    // Specifies the group to return information for. You can specify the group
    // name, the ARN, or the group ID as the GroupIdentifier.
    //
    // GroupIdentifier is a required field
    GroupIdentifier *string `location:"uri" locationName:"groupIdentifier" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetGroupInput) GoString

func (s GetGroupInput) 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 (*GetGroupInput) SetGroupIdentifier

func (s *GetGroupInput) SetGroupIdentifier(v string) *GetGroupInput

SetGroupIdentifier sets the GroupIdentifier field's value.

func (GetGroupInput) String

func (s GetGroupInput) 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".

func (*GetGroupInput) Validate

func (s *GetGroupInput) Validate() error

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

type GetGroupOutput

type GetGroupOutput struct {

    // A structure that contains information about the group.
    Group *Group `type:"structure"`
    // contains filtered or unexported fields
}

func (GetGroupOutput) GoString

func (s GetGroupOutput) 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 (*GetGroupOutput) SetGroup

func (s *GetGroupOutput) SetGroup(v *Group) *GetGroupOutput

SetGroup sets the Group field's value.

func (GetGroupOutput) String

func (s GetGroupOutput) 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 Group

type Group struct {

    // The ARN of the group.
    Arn *string `min:"1" type:"string"`

    // The date and time that the group was created.
    CreatedTime *time.Time `type:"timestamp"`

    // The unique ID of the group.
    Id *string `min:"1" type:"string"`

    // The date and time that the group was most recently updated.
    LastModifiedTime *time.Time `type:"timestamp"`

    // The name of the group.
    Name *string `min:"1" type:"string"`

    // The list of key-value pairs that are associated with the canary.
    Tags map[string]*string `min:"1" type:"map"`
    // contains filtered or unexported fields
}

This structure contains information about one group.

func (Group) GoString

func (s Group) 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 (*Group) SetArn

func (s *Group) SetArn(v string) *Group

SetArn sets the Arn field's value.

func (*Group) SetCreatedTime

func (s *Group) SetCreatedTime(v time.Time) *Group

SetCreatedTime sets the CreatedTime field's value.

func (*Group) SetId

func (s *Group) SetId(v string) *Group

SetId sets the Id field's value.

func (*Group) SetLastModifiedTime

func (s *Group) SetLastModifiedTime(v time.Time) *Group

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*Group) SetName

func (s *Group) SetName(v string) *Group

SetName sets the Name field's value.

func (*Group) SetTags

func (s *Group) SetTags(v map[string]*string) *Group

SetTags sets the Tags field's value.

func (Group) String

func (s Group) 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 GroupSummary

type GroupSummary struct {

    // The ARN of the group.
    Arn *string `min:"1" type:"string"`

    // The unique ID of the group.
    Id *string `min:"1" type:"string"`

    // The name of the group.
    Name *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

A structure containing some information about a group.

func (GroupSummary) GoString

func (s GroupSummary) 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 (*GroupSummary) SetArn

func (s *GroupSummary) SetArn(v string) *GroupSummary

SetArn sets the Arn field's value.

func (*GroupSummary) SetId

func (s *GroupSummary) SetId(v string) *GroupSummary

SetId sets the Id field's value.

func (*GroupSummary) SetName

func (s *GroupSummary) SetName(v string) *GroupSummary

SetName sets the Name field's value.

func (GroupSummary) String

func (s GroupSummary) 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 InternalFailureException

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

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

An internal failure occurred. Try the operation again.

func (*InternalFailureException) Code

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString

func (s InternalFailureException) 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 (*InternalFailureException) Message

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode

func (s *InternalFailureException) StatusCode() int

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

func (InternalFailureException) String

func (s InternalFailureException) 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 InternalServerException

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

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

An unknown internal error occurred.

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 ListAssociatedGroupsInput

type ListAssociatedGroupsInput struct {

    // Specify this parameter to limit how many groups are returned each time you
    // use the ListAssociatedGroups operation. If you omit this parameter, the default
    // of 20 is used.
    MaxResults *int64 `min:"1" type:"integer"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent operation to retrieve the next set of results.
    NextToken *string `min:"1" type:"string"`

    // The ARN of the canary that you want to view groups for.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListAssociatedGroupsInput) GoString

func (s ListAssociatedGroupsInput) 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 (*ListAssociatedGroupsInput) SetMaxResults

func (s *ListAssociatedGroupsInput) SetMaxResults(v int64) *ListAssociatedGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssociatedGroupsInput) SetNextToken

func (s *ListAssociatedGroupsInput) SetNextToken(v string) *ListAssociatedGroupsInput

SetNextToken sets the NextToken field's value.

func (*ListAssociatedGroupsInput) SetResourceArn

func (s *ListAssociatedGroupsInput) SetResourceArn(v string) *ListAssociatedGroupsInput

SetResourceArn sets the ResourceArn field's value.

func (ListAssociatedGroupsInput) String

func (s ListAssociatedGroupsInput) 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".

func (*ListAssociatedGroupsInput) Validate

func (s *ListAssociatedGroupsInput) Validate() error

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

type ListAssociatedGroupsOutput

type ListAssociatedGroupsOutput struct {

    // An array of structures that contain information about the groups that this
    // canary is associated with.
    Groups []*GroupSummary `type:"list"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent ListAssociatedGroups operation to retrieve the next
    // set of results.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAssociatedGroupsOutput) GoString

func (s ListAssociatedGroupsOutput) 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 (*ListAssociatedGroupsOutput) SetGroups

func (s *ListAssociatedGroupsOutput) SetGroups(v []*GroupSummary) *ListAssociatedGroupsOutput

SetGroups sets the Groups field's value.

func (*ListAssociatedGroupsOutput) SetNextToken

func (s *ListAssociatedGroupsOutput) SetNextToken(v string) *ListAssociatedGroupsOutput

SetNextToken sets the NextToken field's value.

func (ListAssociatedGroupsOutput) String

func (s ListAssociatedGroupsOutput) 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 ListGroupResourcesInput

type ListGroupResourcesInput struct {

    // Specifies the group to return information for. You can specify the group
    // name, the ARN, or the group ID as the GroupIdentifier.
    //
    // GroupIdentifier is a required field
    GroupIdentifier *string `location:"uri" locationName:"groupIdentifier" min:"1" type:"string" required:"true"`

    // Specify this parameter to limit how many canary ARNs are returned each time
    // you use the ListGroupResources operation. If you omit this parameter, the
    // default of 20 is used.
    MaxResults *int64 `min:"1" type:"integer"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent operation to retrieve the next set of results.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListGroupResourcesInput) GoString

func (s ListGroupResourcesInput) 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 (*ListGroupResourcesInput) SetGroupIdentifier

func (s *ListGroupResourcesInput) SetGroupIdentifier(v string) *ListGroupResourcesInput

SetGroupIdentifier sets the GroupIdentifier field's value.

func (*ListGroupResourcesInput) SetMaxResults

func (s *ListGroupResourcesInput) SetMaxResults(v int64) *ListGroupResourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupResourcesInput) SetNextToken

func (s *ListGroupResourcesInput) SetNextToken(v string) *ListGroupResourcesInput

SetNextToken sets the NextToken field's value.

func (ListGroupResourcesInput) String

func (s ListGroupResourcesInput) 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".

func (*ListGroupResourcesInput) Validate

func (s *ListGroupResourcesInput) Validate() error

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

type ListGroupResourcesOutput

type ListGroupResourcesOutput struct {

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent ListGroupResources operation to retrieve the next set
    // of results.
    NextToken *string `min:"1" type:"string"`

    // An array of ARNs. These ARNs are for the canaries that are associated with
    // the group.
    Resources []*string `type:"list"`
    // contains filtered or unexported fields
}

func (ListGroupResourcesOutput) GoString

func (s ListGroupResourcesOutput) 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 (*ListGroupResourcesOutput) SetNextToken

func (s *ListGroupResourcesOutput) SetNextToken(v string) *ListGroupResourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListGroupResourcesOutput) SetResources

func (s *ListGroupResourcesOutput) SetResources(v []*string) *ListGroupResourcesOutput

SetResources sets the Resources field's value.

func (ListGroupResourcesOutput) String

func (s ListGroupResourcesOutput) 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 ListGroupsInput

type ListGroupsInput struct {

    // Specify this parameter to limit how many groups are returned each time you
    // use the ListGroups operation. If you omit this parameter, the default of
    // 20 is used.
    MaxResults *int64 `min:"1" type:"integer"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent operation to retrieve the next set of results.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListGroupsInput) GoString

func (s ListGroupsInput) 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 (*ListGroupsInput) SetMaxResults

func (s *ListGroupsInput) SetMaxResults(v int64) *ListGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsInput) SetNextToken

func (s *ListGroupsInput) SetNextToken(v string) *ListGroupsInput

SetNextToken sets the NextToken field's value.

func (ListGroupsInput) String

func (s ListGroupsInput) 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".

func (*ListGroupsInput) Validate

func (s *ListGroupsInput) Validate() error

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

type ListGroupsOutput

type ListGroupsOutput struct {

    // An array of structures that each contain information about one group.
    Groups []*GroupSummary `type:"list"`

    // A token that indicates that there is more data available. You can use this
    // token in a subsequent ListGroups operation to retrieve the next set of results.
    NextToken *string `min:"4" type:"string"`
    // contains filtered or unexported fields
}

func (ListGroupsOutput) GoString

func (s ListGroupsOutput) 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 (*ListGroupsOutput) SetGroups

func (s *ListGroupsOutput) SetGroups(v []*GroupSummary) *ListGroupsOutput

SetGroups sets the Groups field's value.

func (*ListGroupsOutput) SetNextToken

func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput

SetNextToken sets the NextToken field's value.

func (ListGroupsOutput) String

func (s ListGroupsOutput) 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 ListTagsForResourceInput

type ListTagsForResourceInput struct {

    // The ARN of the canary or group that you want to view tags for.
    //
    // The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
    //
    // The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) 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 (*ListTagsForResourceInput) SetResourceArn

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) 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".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

    // The list of tag keys and values associated with the resource that you specified.
    Tags map[string]*string `min:"1" type:"map"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) 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 (*ListTagsForResourceOutput) SetTags

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) 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 NotFoundException

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

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

The specified resource was not found.

func (*NotFoundException) Code

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error

func (s *NotFoundException) Error() string

func (NotFoundException) GoString

func (s NotFoundException) 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 (*NotFoundException) Message

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode

func (s *NotFoundException) StatusCode() int

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

func (NotFoundException) String

func (s NotFoundException) 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 RequestEntityTooLargeException

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

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

One of the input resources is larger than is allowed.

func (*RequestEntityTooLargeException) Code

func (s *RequestEntityTooLargeException) Code() string

Code returns the exception type name.

func (*RequestEntityTooLargeException) Error

func (s *RequestEntityTooLargeException) Error() string

func (RequestEntityTooLargeException) GoString

func (s RequestEntityTooLargeException) 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 (*RequestEntityTooLargeException) Message

func (s *RequestEntityTooLargeException) Message() string

Message returns the exception's message.

func (*RequestEntityTooLargeException) OrigErr

func (s *RequestEntityTooLargeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestEntityTooLargeException) RequestID

func (s *RequestEntityTooLargeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestEntityTooLargeException) StatusCode

func (s *RequestEntityTooLargeException) StatusCode() int

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

func (RequestEntityTooLargeException) String

func (s RequestEntityTooLargeException) 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"`
    // contains filtered or unexported fields
}

One of the specified resources was not found.

func (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

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 RuntimeVersion

type RuntimeVersion struct {

    // If this runtime version is deprecated, this value is the date of deprecation.
    DeprecationDate *time.Time `type:"timestamp"`

    // A description of the runtime version, created by Amazon.
    Description *string `min:"1" type:"string"`

    // The date that the runtime version was released.
    ReleaseDate *time.Time `type:"timestamp"`

    // The name of the runtime version. For a list of valid runtime versions, see
    // Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).
    VersionName *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

This structure contains information about one canary runtime version. For more information about runtime versions, see Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).

func (RuntimeVersion) GoString

func (s RuntimeVersion) 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 (*RuntimeVersion) SetDeprecationDate

func (s *RuntimeVersion) SetDeprecationDate(v time.Time) *RuntimeVersion

SetDeprecationDate sets the DeprecationDate field's value.

func (*RuntimeVersion) SetDescription

func (s *RuntimeVersion) SetDescription(v string) *RuntimeVersion

SetDescription sets the Description field's value.

func (*RuntimeVersion) SetReleaseDate

func (s *RuntimeVersion) SetReleaseDate(v time.Time) *RuntimeVersion

SetReleaseDate sets the ReleaseDate field's value.

func (*RuntimeVersion) SetVersionName

func (s *RuntimeVersion) SetVersionName(v string) *RuntimeVersion

SetVersionName sets the VersionName field's value.

func (RuntimeVersion) String

func (s RuntimeVersion) 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 S3EncryptionConfig

type S3EncryptionConfig struct {

    // The encryption method to use for artifacts created by this canary. Specify
    // SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key.
    // Specify SSE-KMS to use server-side encryption with a customer-managed KMS
    // key.
    //
    // If you omit this parameter, an Amazon Web Services-managed KMS key is used.
    EncryptionMode *string `type:"string" enum:"EncryptionMode"`

    // The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for
    // EncryptionMode
    KmsKeyArn *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

A structure that contains the configuration of encryption-at-rest settings for canary artifacts that the canary uploads to Amazon S3.

For more information, see Encrypting canary artifacts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html)

func (S3EncryptionConfig) GoString

func (s S3EncryptionConfig) 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 (*S3EncryptionConfig) SetEncryptionMode

func (s *S3EncryptionConfig) SetEncryptionMode(v string) *S3EncryptionConfig

SetEncryptionMode sets the EncryptionMode field's value.

func (*S3EncryptionConfig) SetKmsKeyArn

func (s *S3EncryptionConfig) SetKmsKeyArn(v string) *S3EncryptionConfig

SetKmsKeyArn sets the KmsKeyArn field's value.

func (S3EncryptionConfig) String

func (s S3EncryptionConfig) 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".

func (*S3EncryptionConfig) Validate

func (s *S3EncryptionConfig) Validate() error

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

type ServiceQuotaExceededException

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

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

The request exceeded a service quota value.

func (*ServiceQuotaExceededException) Code

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString

func (s ServiceQuotaExceededException) 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 (*ServiceQuotaExceededException) Message

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String

func (s ServiceQuotaExceededException) 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 StartCanaryInput

type StartCanaryInput struct {

    // The name of the canary that you want to run. To find canary names, use DescribeCanaries
    // (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html).
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (StartCanaryInput) GoString

func (s StartCanaryInput) 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 (*StartCanaryInput) SetName

func (s *StartCanaryInput) SetName(v string) *StartCanaryInput

SetName sets the Name field's value.

func (StartCanaryInput) String

func (s StartCanaryInput) 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".

func (*StartCanaryInput) Validate

func (s *StartCanaryInput) Validate() error

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

type StartCanaryOutput

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

func (StartCanaryOutput) GoString

func (s StartCanaryOutput) 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 (StartCanaryOutput) String

func (s StartCanaryOutput) 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 StopCanaryInput

type StopCanaryInput struct {

    // The name of the canary that you want to stop. To find the names of your canaries,
    // use ListCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html).
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (StopCanaryInput) GoString

func (s StopCanaryInput) 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 (*StopCanaryInput) SetName

func (s *StopCanaryInput) SetName(v string) *StopCanaryInput

SetName sets the Name field's value.

func (StopCanaryInput) String

func (s StopCanaryInput) 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".

func (*StopCanaryInput) Validate

func (s *StopCanaryInput) Validate() error

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

type StopCanaryOutput

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

func (StopCanaryOutput) GoString

func (s StopCanaryOutput) 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 (StopCanaryOutput) String

func (s StopCanaryOutput) 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 Synthetics

type Synthetics struct {
    *client.Client
}

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

Synthetics 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) *Synthetics

New creates a new instance of the Synthetics 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 Synthetics client from just a session.
svc := synthetics.New(mySession)

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

func (*Synthetics) AssociateResource

func (c *Synthetics) AssociateResource(input *AssociateResourceInput) (*AssociateResourceOutput, error)

AssociateResource API operation for Synthetics.

Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

You must run this operation in the Region where the canary exists.

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 Synthetics's API operation AssociateResource for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

  • ServiceQuotaExceededException The request exceeded a service quota value.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResource

func (*Synthetics) AssociateResourceRequest

func (c *Synthetics) AssociateResourceRequest(input *AssociateResourceInput) (req *request.Request, output *AssociateResourceOutput)

AssociateResourceRequest generates a "aws/request.Request" representing the client's request for the AssociateResource 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 AssociateResource for more information on using the AssociateResource 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 AssociateResourceRequest method.
req, resp := client.AssociateResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AssociateResource

func (*Synthetics) AssociateResourceWithContext

func (c *Synthetics) AssociateResourceWithContext(ctx aws.Context, input *AssociateResourceInput, opts ...request.Option) (*AssociateResourceOutput, error)

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

See AssociateResource 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 (*Synthetics) CreateCanary

func (c *Synthetics) CreateCanary(input *CreateCanaryInput) (*CreateCanaryOutput, error)

CreateCanary API operation for Synthetics.

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.

Do not use CreateCanary to modify an existing canary. Use UpdateCanary (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html) instead.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles).

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html).

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 Synthetics's API operation CreateCanary for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • RequestEntityTooLargeException One of the input resources is larger than is allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateCanary

func (*Synthetics) CreateCanaryRequest

func (c *Synthetics) CreateCanaryRequest(input *CreateCanaryInput) (req *request.Request, output *CreateCanaryOutput)

CreateCanaryRequest generates a "aws/request.Request" representing the client's request for the CreateCanary 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 CreateCanary for more information on using the CreateCanary 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 CreateCanaryRequest method.
req, resp := client.CreateCanaryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateCanary

func (*Synthetics) CreateCanaryWithContext

func (c *Synthetics) CreateCanaryWithContext(ctx aws.Context, input *CreateCanaryInput, opts ...request.Option) (*CreateCanaryOutput, error)

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

See CreateCanary 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 (*Synthetics) CreateGroup

func (c *Synthetics) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)

CreateGroup API operation for Synthetics.

Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.

Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.

Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable).

Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.

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 Synthetics's API operation CreateGroup for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ConflictException A conflicting operation is already in progress.

  • ServiceQuotaExceededException The request exceeded a service quota value.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateGroup

func (*Synthetics) CreateGroupRequest

func (c *Synthetics) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)

CreateGroupRequest generates a "aws/request.Request" representing the client's request for the CreateGroup 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 CreateGroup for more information on using the CreateGroup 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 CreateGroupRequest method.
req, resp := client.CreateGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateGroup

func (*Synthetics) CreateGroupWithContext

func (c *Synthetics) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)

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

See CreateGroup 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 (*Synthetics) DeleteCanary

func (c *Synthetics) DeleteCanary(input *DeleteCanaryInput) (*DeleteCanaryOutput, error)

DeleteCanary API operation for Synthetics.

Permanently deletes the specified canary.

If you specify DeleteLambda to true, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.

Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:

  • The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName .

  • Amazon S3 objects and buckets, such as the canary's artifact location.

  • IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName .

  • CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName .

Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.

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 Synthetics's API operation DeleteCanary for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteCanary

func (*Synthetics) DeleteCanaryRequest

func (c *Synthetics) DeleteCanaryRequest(input *DeleteCanaryInput) (req *request.Request, output *DeleteCanaryOutput)

DeleteCanaryRequest generates a "aws/request.Request" representing the client's request for the DeleteCanary 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 DeleteCanary for more information on using the DeleteCanary 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 DeleteCanaryRequest method.
req, resp := client.DeleteCanaryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteCanary

func (*Synthetics) DeleteCanaryWithContext

func (c *Synthetics) DeleteCanaryWithContext(ctx aws.Context, input *DeleteCanaryInput, opts ...request.Option) (*DeleteCanaryOutput, error)

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

See DeleteCanary 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 (*Synthetics) DeleteGroup

func (c *Synthetics) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)

DeleteGroup API operation for Synthetics.

Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group.

Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN.

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 Synthetics's API operation DeleteGroup for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteGroup

func (*Synthetics) DeleteGroupRequest

func (c *Synthetics) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)

DeleteGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGroup 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 DeleteGroup for more information on using the DeleteGroup 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 DeleteGroupRequest method.
req, resp := client.DeleteGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DeleteGroup

func (*Synthetics) DeleteGroupWithContext

func (c *Synthetics) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)

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

See DeleteGroup 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 (*Synthetics) DescribeCanaries

func (c *Synthetics) DescribeCanaries(input *DescribeCanariesInput) (*DescribeCanariesOutput, error)

DescribeCanaries API operation for Synthetics.

This operation returns a list of the canaries in your account, along with full details about each canary.

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html).

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 Synthetics's API operation DescribeCanaries for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanaries

func (*Synthetics) DescribeCanariesLastRun

func (c *Synthetics) DescribeCanariesLastRun(input *DescribeCanariesLastRunInput) (*DescribeCanariesLastRunOutput, error)

DescribeCanariesLastRun API operation for Synthetics.

Use this operation to see information from the most recent run of each canary that you have created.

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html).

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 Synthetics's API operation DescribeCanariesLastRun for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesLastRun

func (*Synthetics) DescribeCanariesLastRunPages

func (c *Synthetics) DescribeCanariesLastRunPages(input *DescribeCanariesLastRunInput, fn func(*DescribeCanariesLastRunOutput, bool) bool) error

DescribeCanariesLastRunPages iterates over the pages of a DescribeCanariesLastRun operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCanariesLastRun method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCanariesLastRun operation.
pageNum := 0
err := client.DescribeCanariesLastRunPages(params,
    func(page *synthetics.DescribeCanariesLastRunOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Synthetics) DescribeCanariesLastRunPagesWithContext

func (c *Synthetics) DescribeCanariesLastRunPagesWithContext(ctx aws.Context, input *DescribeCanariesLastRunInput, fn func(*DescribeCanariesLastRunOutput, bool) bool, opts ...request.Option) error

DescribeCanariesLastRunPagesWithContext same as DescribeCanariesLastRunPages except it takes a Context and allows setting request options on the pages.

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 (*Synthetics) DescribeCanariesLastRunRequest

func (c *Synthetics) DescribeCanariesLastRunRequest(input *DescribeCanariesLastRunInput) (req *request.Request, output *DescribeCanariesLastRunOutput)

DescribeCanariesLastRunRequest generates a "aws/request.Request" representing the client's request for the DescribeCanariesLastRun 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 DescribeCanariesLastRun for more information on using the DescribeCanariesLastRun 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 DescribeCanariesLastRunRequest method.
req, resp := client.DescribeCanariesLastRunRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesLastRun

func (*Synthetics) DescribeCanariesLastRunWithContext

func (c *Synthetics) DescribeCanariesLastRunWithContext(ctx aws.Context, input *DescribeCanariesLastRunInput, opts ...request.Option) (*DescribeCanariesLastRunOutput, error)

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

See DescribeCanariesLastRun 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 (*Synthetics) DescribeCanariesPages

func (c *Synthetics) DescribeCanariesPages(input *DescribeCanariesInput, fn func(*DescribeCanariesOutput, bool) bool) error

DescribeCanariesPages iterates over the pages of a DescribeCanaries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeCanaries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeCanaries operation.
pageNum := 0
err := client.DescribeCanariesPages(params,
    func(page *synthetics.DescribeCanariesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Synthetics) DescribeCanariesPagesWithContext

func (c *Synthetics) DescribeCanariesPagesWithContext(ctx aws.Context, input *DescribeCanariesInput, fn func(*DescribeCanariesOutput, bool) bool, opts ...request.Option) error

DescribeCanariesPagesWithContext same as DescribeCanariesPages except it takes a Context and allows setting request options on the pages.

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 (*Synthetics) DescribeCanariesRequest

func (c *Synthetics) DescribeCanariesRequest(input *DescribeCanariesInput) (req *request.Request, output *DescribeCanariesOutput)

DescribeCanariesRequest generates a "aws/request.Request" representing the client's request for the DescribeCanaries 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 DescribeCanaries for more information on using the DescribeCanaries 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 DescribeCanariesRequest method.
req, resp := client.DescribeCanariesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanaries

func (*Synthetics) DescribeCanariesWithContext

func (c *Synthetics) DescribeCanariesWithContext(ctx aws.Context, input *DescribeCanariesInput, opts ...request.Option) (*DescribeCanariesOutput, error)

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

See DescribeCanaries 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 (*Synthetics) DescribeRuntimeVersions

func (c *Synthetics) DescribeRuntimeVersions(input *DescribeRuntimeVersionsInput) (*DescribeRuntimeVersionsOutput, error)

DescribeRuntimeVersions API operation for Synthetics.

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).

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 Synthetics's API operation DescribeRuntimeVersions for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeRuntimeVersions

func (*Synthetics) DescribeRuntimeVersionsPages

func (c *Synthetics) DescribeRuntimeVersionsPages(input *DescribeRuntimeVersionsInput, fn func(*DescribeRuntimeVersionsOutput, bool) bool) error

DescribeRuntimeVersionsPages iterates over the pages of a DescribeRuntimeVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeRuntimeVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeRuntimeVersions operation.
pageNum := 0
err := client.DescribeRuntimeVersionsPages(params,
    func(page *synthetics.DescribeRuntimeVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Synthetics) DescribeRuntimeVersionsPagesWithContext

func (c *Synthetics) DescribeRuntimeVersionsPagesWithContext(ctx aws.Context, input *DescribeRuntimeVersionsInput, fn func(*DescribeRuntimeVersionsOutput, bool) bool, opts ...request.Option) error

DescribeRuntimeVersionsPagesWithContext same as DescribeRuntimeVersionsPages except it takes a Context and allows setting request options on the pages.

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 (*Synthetics) DescribeRuntimeVersionsRequest

func (c *Synthetics) DescribeRuntimeVersionsRequest(input *DescribeRuntimeVersionsInput) (req *request.Request, output *DescribeRuntimeVersionsOutput)

DescribeRuntimeVersionsRequest generates a "aws/request.Request" representing the client's request for the DescribeRuntimeVersions 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 DescribeRuntimeVersions for more information on using the DescribeRuntimeVersions 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 DescribeRuntimeVersionsRequest method.
req, resp := client.DescribeRuntimeVersionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeRuntimeVersions

func (*Synthetics) DescribeRuntimeVersionsWithContext

func (c *Synthetics) DescribeRuntimeVersionsWithContext(ctx aws.Context, input *DescribeRuntimeVersionsInput, opts ...request.Option) (*DescribeRuntimeVersionsOutput, error)

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

See DescribeRuntimeVersions 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 (*Synthetics) DisassociateResource

func (c *Synthetics) DisassociateResource(input *DisassociateResourceInput) (*DisassociateResourceOutput, error)

DisassociateResource API operation for Synthetics.

Removes a canary from a group. You must run this operation in the Region where the canary exists.

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 Synthetics's API operation DisassociateResource for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DisassociateResource

func (*Synthetics) DisassociateResourceRequest

func (c *Synthetics) DisassociateResourceRequest(input *DisassociateResourceInput) (req *request.Request, output *DisassociateResourceOutput)

DisassociateResourceRequest generates a "aws/request.Request" representing the client's request for the DisassociateResource 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 DisassociateResource for more information on using the DisassociateResource 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 DisassociateResourceRequest method.
req, resp := client.DisassociateResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DisassociateResource

func (*Synthetics) DisassociateResourceWithContext

func (c *Synthetics) DisassociateResourceWithContext(ctx aws.Context, input *DisassociateResourceInput, opts ...request.Option) (*DisassociateResourceOutput, error)

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

See DisassociateResource 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 (*Synthetics) GetCanary

func (c *Synthetics) GetCanary(input *GetCanaryInput) (*GetCanaryOutput, error)

GetCanary API operation for Synthetics.

Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html).

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 Synthetics's API operation GetCanary for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanary

func (*Synthetics) GetCanaryRequest

func (c *Synthetics) GetCanaryRequest(input *GetCanaryInput) (req *request.Request, output *GetCanaryOutput)

GetCanaryRequest generates a "aws/request.Request" representing the client's request for the GetCanary 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 GetCanary for more information on using the GetCanary 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 GetCanaryRequest method.
req, resp := client.GetCanaryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanary

func (*Synthetics) GetCanaryRuns

func (c *Synthetics) GetCanaryRuns(input *GetCanaryRunsInput) (*GetCanaryRunsOutput, error)

GetCanaryRuns API operation for Synthetics.

Retrieves a list of runs for a specified canary.

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 Synthetics's API operation GetCanaryRuns for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRuns

func (*Synthetics) GetCanaryRunsPages

func (c *Synthetics) GetCanaryRunsPages(input *GetCanaryRunsInput, fn func(*GetCanaryRunsOutput, bool) bool) error

GetCanaryRunsPages iterates over the pages of a GetCanaryRuns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetCanaryRuns method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetCanaryRuns operation.
pageNum := 0
err := client.GetCanaryRunsPages(params,
    func(page *synthetics.GetCanaryRunsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Synthetics) GetCanaryRunsPagesWithContext

func (c *Synthetics) GetCanaryRunsPagesWithContext(ctx aws.Context, input *GetCanaryRunsInput, fn func(*GetCanaryRunsOutput, bool) bool, opts ...request.Option) error

GetCanaryRunsPagesWithContext same as GetCanaryRunsPages except it takes a Context and allows setting request options on the pages.

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 (*Synthetics) GetCanaryRunsRequest

func (c *Synthetics) GetCanaryRunsRequest(input *GetCanaryRunsInput) (req *request.Request, output *GetCanaryRunsOutput)

GetCanaryRunsRequest generates a "aws/request.Request" representing the client's request for the GetCanaryRuns 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 GetCanaryRuns for more information on using the GetCanaryRuns 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 GetCanaryRunsRequest method.
req, resp := client.GetCanaryRunsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRuns

func (*Synthetics) GetCanaryRunsWithContext

func (c *Synthetics) GetCanaryRunsWithContext(ctx aws.Context, input *GetCanaryRunsInput, opts ...request.Option) (*GetCanaryRunsOutput, error)

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

See GetCanaryRuns 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 (*Synthetics) GetCanaryWithContext

func (c *Synthetics) GetCanaryWithContext(ctx aws.Context, input *GetCanaryInput, opts ...request.Option) (*GetCanaryOutput, error)

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

See GetCanary 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 (*Synthetics) GetGroup

func (c *Synthetics) GetGroup(input *GetGroupInput) (*GetGroupOutput, error)

GetGroup API operation for Synthetics.

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

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 Synthetics's API operation GetGroup for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetGroup

func (*Synthetics) GetGroupRequest

func (c *Synthetics) GetGroupRequest(input *GetGroupInput) (req *request.Request, output *GetGroupOutput)

GetGroupRequest generates a "aws/request.Request" representing the client's request for the GetGroup 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 GetGroup for more information on using the GetGroup 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 GetGroupRequest method.
req, resp := client.GetGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetGroup

func (*Synthetics) GetGroupWithContext

func (c *Synthetics) GetGroupWithContext(ctx aws.Context, input *GetGroupInput, opts ...request.Option) (*GetGroupOutput, error)

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

See GetGroup 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 (*Synthetics) ListAssociatedGroups

func (c *Synthetics) ListAssociatedGroups(input *ListAssociatedGroupsInput) (*ListAssociatedGroupsOutput, error)

ListAssociatedGroups API operation for Synthetics.

Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.

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 Synthetics's API operation ListAssociatedGroups for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListAssociatedGroups

func (*Synthetics) ListAssociatedGroupsPages

func (c *Synthetics) ListAssociatedGroupsPages(input *ListAssociatedGroupsInput, fn func(*ListAssociatedGroupsOutput, bool) bool) error

ListAssociatedGroupsPages iterates over the pages of a ListAssociatedGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssociatedGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAssociatedGroups operation.
pageNum := 0
err := client.ListAssociatedGroupsPages(params,
    func(page *synthetics.ListAssociatedGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Synthetics) ListAssociatedGroupsPagesWithContext

func (c *Synthetics) ListAssociatedGroupsPagesWithContext(ctx aws.Context, input *ListAssociatedGroupsInput, fn func(*ListAssociatedGroupsOutput, bool) bool, opts ...request.Option) error

ListAssociatedGroupsPagesWithContext same as ListAssociatedGroupsPages except it takes a Context and allows setting request options on the pages.

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 (*Synthetics) ListAssociatedGroupsRequest

func (c *Synthetics) ListAssociatedGroupsRequest(input *ListAssociatedGroupsInput) (req *request.Request, output *ListAssociatedGroupsOutput)

ListAssociatedGroupsRequest generates a "aws/request.Request" representing the client's request for the ListAssociatedGroups 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 ListAssociatedGroups for more information on using the ListAssociatedGroups 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 ListAssociatedGroupsRequest method.
req, resp := client.ListAssociatedGroupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListAssociatedGroups

func (*Synthetics) ListAssociatedGroupsWithContext

func (c *Synthetics) ListAssociatedGroupsWithContext(ctx aws.Context, input *ListAssociatedGroupsInput, opts ...request.Option) (*ListAssociatedGroupsOutput, error)

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

See ListAssociatedGroups 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 (*Synthetics) ListGroupResources

func (c *Synthetics) ListGroupResources(input *ListGroupResourcesInput) (*ListGroupResourcesOutput, error)

ListGroupResources API operation for Synthetics.

This operation returns a list of the ARNs of the canaries that are associated with the specified group.

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 Synthetics's API operation ListGroupResources for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupResources

func (*Synthetics) ListGroupResourcesPages

func (c *Synthetics) ListGroupResourcesPages(input *ListGroupResourcesInput, fn func(*ListGroupResourcesOutput, bool) bool) error

ListGroupResourcesPages iterates over the pages of a ListGroupResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGroupResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListGroupResources operation.
pageNum := 0
err := client.ListGroupResourcesPages(params,
    func(page *synthetics.ListGroupResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Synthetics) ListGroupResourcesPagesWithContext

func (c *Synthetics) ListGroupResourcesPagesWithContext(ctx aws.Context, input *ListGroupResourcesInput, fn func(*ListGroupResourcesOutput, bool) bool, opts ...request.Option) error

ListGroupResourcesPagesWithContext same as ListGroupResourcesPages except it takes a Context and allows setting request options on the pages.

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 (*Synthetics) ListGroupResourcesRequest

func (c *Synthetics) ListGroupResourcesRequest(input *ListGroupResourcesInput) (req *request.Request, output *ListGroupResourcesOutput)

ListGroupResourcesRequest generates a "aws/request.Request" representing the client's request for the ListGroupResources 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 ListGroupResources for more information on using the ListGroupResources 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 ListGroupResourcesRequest method.
req, resp := client.ListGroupResourcesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroupResources

func (*Synthetics) ListGroupResourcesWithContext

func (c *Synthetics) ListGroupResourcesWithContext(ctx aws.Context, input *ListGroupResourcesInput, opts ...request.Option) (*ListGroupResourcesOutput, error)

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

See ListGroupResources 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 (*Synthetics) ListGroups

func (c *Synthetics) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)

ListGroups API operation for Synthetics.

Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.

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 Synthetics's API operation ListGroups for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroups

func (*Synthetics) ListGroupsPages

func (c *Synthetics) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error

ListGroupsPages iterates over the pages of a ListGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListGroups operation.
pageNum := 0
err := client.ListGroupsPages(params,
    func(page *synthetics.ListGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Synthetics) ListGroupsPagesWithContext

func (c *Synthetics) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, opts ...request.Option) error

ListGroupsPagesWithContext same as ListGroupsPages except it takes a Context and allows setting request options on the pages.

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 (*Synthetics) ListGroupsRequest

func (c *Synthetics) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)

ListGroupsRequest generates a "aws/request.Request" representing the client's request for the ListGroups 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 ListGroups for more information on using the ListGroups 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 ListGroupsRequest method.
req, resp := client.ListGroupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListGroups

func (*Synthetics) ListGroupsWithContext

func (c *Synthetics) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)

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

See ListGroups 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 (*Synthetics) ListTagsForResource

func (c *Synthetics) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Synthetics.

Displays the tags associated with a canary or group.

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 Synthetics's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • BadRequestException The request was not valid.

  • NotFoundException The specified resource was not found.

  • TooManyRequestsException There were too many simultaneous requests. Try the operation again.

  • ConflictException A conflicting operation is already in progress.

  • InternalFailureException An internal failure occurred. Try the operation again.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListTagsForResource

func (*Synthetics) ListTagsForResourceRequest

func (c *Synthetics) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/ListTagsForResource

func (*Synthetics) ListTagsForResourceWithContext

func (c *Synthetics) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 (*Synthetics) StartCanary

func (c *Synthetics) StartCanary(input *StartCanaryInput) (*StartCanaryOutput, error)

StartCanary API operation for Synthetics.

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanary.html).

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 Synthetics's API operation StartCanary for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanary

func (*Synthetics) StartCanaryRequest

func (c *Synthetics) StartCanaryRequest(input *StartCanaryInput) (req *request.Request, output *StartCanaryOutput)

StartCanaryRequest generates a "aws/request.Request" representing the client's request for the StartCanary 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 StartCanary for more information on using the StartCanary 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 StartCanaryRequest method.
req, resp := client.StartCanaryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanary

func (*Synthetics) StartCanaryWithContext

func (c *Synthetics) StartCanaryWithContext(ctx aws.Context, input *StartCanaryInput, opts ...request.Option) (*StartCanaryOutput, error)

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

See StartCanary 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 (*Synthetics) StopCanary

func (c *Synthetics) StopCanary(input *StopCanaryInput) (*StopCanaryOutput, error)

StopCanary API operation for Synthetics.

Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.

You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.

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 Synthetics's API operation StopCanary for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StopCanary

func (*Synthetics) StopCanaryRequest

func (c *Synthetics) StopCanaryRequest(input *StopCanaryInput) (req *request.Request, output *StopCanaryOutput)

StopCanaryRequest generates a "aws/request.Request" representing the client's request for the StopCanary 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 StopCanary for more information on using the StopCanary 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 StopCanaryRequest method.
req, resp := client.StopCanaryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StopCanary

func (*Synthetics) StopCanaryWithContext

func (c *Synthetics) StopCanaryWithContext(ctx aws.Context, input *StopCanaryInput, opts ...request.Option) (*StopCanaryOutput, error)

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

See StopCanary 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 (*Synthetics) TagResource

func (c *Synthetics) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Synthetics.

Assigns one or more tags (key-value pairs) to the specified canary or group.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a canary or group.

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 Synthetics's API operation TagResource for usage and error information.

Returned Error Types:

  • BadRequestException The request was not valid.

  • NotFoundException The specified resource was not found.

  • TooManyRequestsException There were too many simultaneous requests. Try the operation again.

  • ConflictException A conflicting operation is already in progress.

  • InternalFailureException An internal failure occurred. Try the operation again.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/TagResource

func (*Synthetics) TagResourceRequest

func (c *Synthetics) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/TagResource

func (*Synthetics) TagResourceWithContext

func (c *Synthetics) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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 (*Synthetics) UntagResource

func (c *Synthetics) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Synthetics.

Removes one or more tags from the specified resource.

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 Synthetics's API operation UntagResource for usage and error information.

Returned Error Types:

  • BadRequestException The request was not valid.

  • NotFoundException The specified resource was not found.

  • TooManyRequestsException There were too many simultaneous requests. Try the operation again.

  • ConflictException A conflicting operation is already in progress.

  • InternalFailureException An internal failure occurred. Try the operation again.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UntagResource

func (*Synthetics) UntagResourceRequest

func (c *Synthetics) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UntagResource

func (*Synthetics) UntagResourceWithContext

func (c *Synthetics) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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 (*Synthetics) UpdateCanary

func (c *Synthetics) UpdateCanary(input *UpdateCanaryInput) (*UpdateCanaryOutput, error)

UpdateCanary API operation for Synthetics.

Updates the configuration of a canary that has already been created.

You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html).

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 Synthetics's API operation UpdateCanary for usage and error information.

Returned Error Types:

  • InternalServerException An unknown internal error occurred.

  • ValidationException A parameter could not be validated.

  • ResourceNotFoundException One of the specified resources was not found.

  • ConflictException A conflicting operation is already in progress.

  • RequestEntityTooLargeException One of the input resources is larger than is allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary

func (*Synthetics) UpdateCanaryRequest

func (c *Synthetics) UpdateCanaryRequest(input *UpdateCanaryInput) (req *request.Request, output *UpdateCanaryOutput)

UpdateCanaryRequest generates a "aws/request.Request" representing the client's request for the UpdateCanary 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 UpdateCanary for more information on using the UpdateCanary 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 UpdateCanaryRequest method.
req, resp := client.UpdateCanaryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary

func (*Synthetics) UpdateCanaryWithContext

func (c *Synthetics) UpdateCanaryWithContext(ctx aws.Context, input *UpdateCanaryInput, opts ...request.Option) (*UpdateCanaryOutput, error)

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

See UpdateCanary 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 TagResourceInput

type TagResourceInput struct {

    // The ARN of the canary or group that you're adding tags to.
    //
    // The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
    //
    // The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

    // The list of key-value pairs to associate with the resource.
    //
    // Tags is a required field
    Tags map[string]*string `min:"1" type:"map" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) 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 (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) 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".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) 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 (TagResourceOutput) String

func (s TagResourceOutput) 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 TooManyRequestsException

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

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

There were too many simultaneous requests. Try the operation again.

func (*TooManyRequestsException) Code

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString

func (s TooManyRequestsException) 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 (*TooManyRequestsException) Message

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode

func (s *TooManyRequestsException) StatusCode() int

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

func (TooManyRequestsException) String

func (s TooManyRequestsException) 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 UntagResourceInput

type UntagResourceInput struct {

    // The ARN of the canary or group that you're removing tags from.
    //
    // The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .
    //
    // The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

    // The list of tag keys to remove from the resource.
    //
    // TagKeys is a required field
    TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) 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 (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) 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".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) 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 (UntagResourceOutput) String

func (s UntagResourceOutput) 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 UpdateCanaryInput

type UpdateCanaryInput struct {

    // A structure that contains the configuration for canary artifacts, including
    // the encryption-at-rest settings for artifacts that the canary uploads to
    // Amazon S3.
    ArtifactConfig *ArtifactConfigInput_ `type:"structure"`

    // The location in Amazon S3 where Synthetics stores artifacts from the test
    // runs of this canary. Artifacts include the log file, screenshots, and HAR
    // files. The name of the S3 bucket can't include a period (.).
    ArtifactS3Location *string `min:"1" type:"string"`

    // A structure that includes the entry point from which the canary should start
    // running your script. If the script is stored in an S3 bucket, the bucket
    // name, key, and version are also included.
    Code *CanaryCodeInput `type:"structure"`

    // The ARN of the IAM role to be used to run the canary. This role must already
    // exist, and must include lambda.amazonaws.com as a principal in the trust
    // policy. The role must also have the following permissions:
    //
    //    * s3:PutObject
    //
    //    * s3:GetBucketLocation
    //
    //    * s3:ListAllMyBuckets
    //
    //    * cloudwatch:PutMetricData
    //
    //    * logs:CreateLogGroup
    //
    //    * logs:CreateLogStream
    //
    //    * logs:CreateLogStream
    ExecutionRoleArn *string `min:"1" type:"string"`

    // The number of days to retain data about failed runs of this canary.
    FailureRetentionPeriodInDays *int64 `min:"1" type:"integer"`

    // The name of the canary that you want to update. To find the names of your
    // canaries, use DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html).
    //
    // You cannot change the name of a canary that has already been created.
    //
    // Name is a required field
    Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

    // A structure that contains the timeout value that is used for each individual
    // run of the canary.
    //
    // The environment variables keys and values are not encrypted. Do not store
    // sensitive information in this field.
    RunConfig *CanaryRunConfigInput `type:"structure"`

    // Specifies the runtime version to use for the canary. For a list of valid
    // runtime versions and for more information about runtime versions, see Canary
    // Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html).
    RuntimeVersion *string `min:"1" type:"string"`

    // A structure that contains information about how often the canary is to run,
    // and when these runs are to stop.
    Schedule *CanaryScheduleInput `type:"structure"`

    // The number of days to retain data about successful runs of this canary.
    SuccessRetentionPeriodInDays *int64 `min:"1" type:"integer"`

    // Defines the screenshots to use as the baseline for comparisons during visual
    // monitoring comparisons during future runs of this canary. If you omit this
    // parameter, no changes are made to any baseline screenshots that the canary
    // might be using already.
    //
    // Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2
    // runtime or later. For more information, see Visual monitoring (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html)
    // and Visual monitoring blueprint (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html)
    VisualReference *VisualReferenceInput_ `type:"structure"`

    // If this canary is to test an endpoint in a VPC, this structure contains information
    // about the subnet and security groups of the VPC endpoint. For more information,
    // see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).
    VpcConfig *VpcConfigInput `type:"structure"`
    // contains filtered or unexported fields
}

func (UpdateCanaryInput) GoString

func (s UpdateCanaryInput) 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 (*UpdateCanaryInput) SetArtifactConfig

func (s *UpdateCanaryInput) SetArtifactConfig(v *ArtifactConfigInput_) *UpdateCanaryInput

SetArtifactConfig sets the ArtifactConfig field's value.

func (*UpdateCanaryInput) SetArtifactS3Location

func (s *UpdateCanaryInput) SetArtifactS3Location(v string) *UpdateCanaryInput

SetArtifactS3Location sets the ArtifactS3Location field's value.

func (*UpdateCanaryInput) SetCode

func (s *UpdateCanaryInput) SetCode(v *CanaryCodeInput) *UpdateCanaryInput

SetCode sets the Code field's value.

func (*UpdateCanaryInput) SetExecutionRoleArn

func (s *UpdateCanaryInput) SetExecutionRoleArn(v string) *UpdateCanaryInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*UpdateCanaryInput) SetFailureRetentionPeriodInDays

func (s *UpdateCanaryInput) SetFailureRetentionPeriodInDays(v int64) *UpdateCanaryInput

SetFailureRetentionPeriodInDays sets the FailureRetentionPeriodInDays field's value.

func (*UpdateCanaryInput) SetName

func (s *UpdateCanaryInput) SetName(v string) *UpdateCanaryInput

SetName sets the Name field's value.

func (*UpdateCanaryInput) SetRunConfig

func (s *UpdateCanaryInput) SetRunConfig(v *CanaryRunConfigInput) *UpdateCanaryInput

SetRunConfig sets the RunConfig field's value.

func (*UpdateCanaryInput) SetRuntimeVersion

func (s *UpdateCanaryInput) SetRuntimeVersion(v string) *UpdateCanaryInput

SetRuntimeVersion sets the RuntimeVersion field's value.

func (*UpdateCanaryInput) SetSchedule

func (s *UpdateCanaryInput) SetSchedule(v *CanaryScheduleInput) *UpdateCanaryInput

SetSchedule sets the Schedule field's value.

func (*UpdateCanaryInput) SetSuccessRetentionPeriodInDays

func (s *UpdateCanaryInput) SetSuccessRetentionPeriodInDays(v int64) *UpdateCanaryInput

SetSuccessRetentionPeriodInDays sets the SuccessRetentionPeriodInDays field's value.

func (*UpdateCanaryInput) SetVisualReference

func (s *UpdateCanaryInput) SetVisualReference(v *VisualReferenceInput_) *UpdateCanaryInput

SetVisualReference sets the VisualReference field's value.

func (*UpdateCanaryInput) SetVpcConfig

func (s *UpdateCanaryInput) SetVpcConfig(v *VpcConfigInput) *UpdateCanaryInput

SetVpcConfig sets the VpcConfig field's value.

func (UpdateCanaryInput) String

func (s UpdateCanaryInput) 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".

func (*UpdateCanaryInput) Validate

func (s *UpdateCanaryInput) Validate() error

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

type UpdateCanaryOutput

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

func (UpdateCanaryOutput) GoString

func (s UpdateCanaryOutput) 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 (UpdateCanaryOutput) String

func (s UpdateCanaryOutput) 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 ValidationException

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

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

A parameter could not be validated.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) 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 (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String

func (s ValidationException) 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 VisualReferenceInput_

type VisualReferenceInput_ struct {

    // Specifies which canary run to use the screenshots from as the baseline for
    // future visual monitoring with this canary. Valid values are nextrun to use
    // the screenshots from the next run after this update is made, lastrun to use
    // the screenshots from the most recent run before this update was made, or
    // the value of Id in the CanaryRun (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html)
    // from any past run of this canary.
    //
    // BaseCanaryRunId is a required field
    BaseCanaryRunId *string `min:"1" type:"string" required:"true"`

    // An array of screenshots that will be used as the baseline for visual monitoring
    // in future runs of this canary. If there is a screenshot that you don't want
    // to be used for visual monitoring, remove it from this array.
    BaseScreenshots []*BaseScreenshot `type:"list"`
    // contains filtered or unexported fields
}

An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) and Visual monitoring blueprint (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html)

func (VisualReferenceInput_) GoString

func (s VisualReferenceInput_) 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 (*VisualReferenceInput_) SetBaseCanaryRunId

func (s *VisualReferenceInput_) SetBaseCanaryRunId(v string) *VisualReferenceInput_

SetBaseCanaryRunId sets the BaseCanaryRunId field's value.

func (*VisualReferenceInput_) SetBaseScreenshots

func (s *VisualReferenceInput_) SetBaseScreenshots(v []*BaseScreenshot) *VisualReferenceInput_

SetBaseScreenshots sets the BaseScreenshots field's value.

func (VisualReferenceInput_) String

func (s VisualReferenceInput_) 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".

func (*VisualReferenceInput_) Validate

func (s *VisualReferenceInput_) Validate() error

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

type VisualReferenceOutput_

type VisualReferenceOutput_ struct {

    // The ID of the canary run that produced the baseline screenshots that are
    // used for visual monitoring comparisons by this canary.
    BaseCanaryRunId *string `min:"1" type:"string"`

    // An array of screenshots that are used as the baseline for comparisons during
    // visual monitoring.
    BaseScreenshots []*BaseScreenshot `type:"list"`
    // contains filtered or unexported fields
}

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates of any parts of those screenshots that are ignored during visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later.

func (VisualReferenceOutput_) GoString

func (s VisualReferenceOutput_) 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 (*VisualReferenceOutput_) SetBaseCanaryRunId

func (s *VisualReferenceOutput_) SetBaseCanaryRunId(v string) *VisualReferenceOutput_

SetBaseCanaryRunId sets the BaseCanaryRunId field's value.

func (*VisualReferenceOutput_) SetBaseScreenshots

func (s *VisualReferenceOutput_) SetBaseScreenshots(v []*BaseScreenshot) *VisualReferenceOutput_

SetBaseScreenshots sets the BaseScreenshots field's value.

func (VisualReferenceOutput_) String

func (s VisualReferenceOutput_) 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 VpcConfigInput

type VpcConfigInput struct {

    // The IDs of the security groups for this canary.
    SecurityGroupIds []*string `type:"list"`

    // The IDs of the subnets where this canary is to run.
    SubnetIds []*string `type:"list"`
    // contains filtered or unexported fields
}

If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).

func (VpcConfigInput) GoString

func (s VpcConfigInput) 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 (*VpcConfigInput) SetSecurityGroupIds

func (s *VpcConfigInput) SetSecurityGroupIds(v []*string) *VpcConfigInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfigInput) SetSubnetIds

func (s *VpcConfigInput) SetSubnetIds(v []*string) *VpcConfigInput

SetSubnetIds sets the SubnetIds field's value.

func (VpcConfigInput) String

func (s VpcConfigInput) 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 VpcConfigOutput

type VpcConfigOutput struct {

    // The IDs of the security groups for this canary.
    SecurityGroupIds []*string `type:"list"`

    // The IDs of the subnets where this canary is to run.
    SubnetIds []*string `type:"list"`

    // The IDs of the VPC where this canary is to run.
    VpcId *string `type:"string"`
    // contains filtered or unexported fields
}

If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).

func (VpcConfigOutput) GoString

func (s VpcConfigOutput) 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 (*VpcConfigOutput) SetSecurityGroupIds

func (s *VpcConfigOutput) SetSecurityGroupIds(v []*string) *VpcConfigOutput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfigOutput) SetSubnetIds

func (s *VpcConfigOutput) SetSubnetIds(v []*string) *VpcConfigOutput

SetSubnetIds sets the SubnetIds field's value.

func (*VpcConfigOutput) SetVpcId

func (s *VpcConfigOutput) SetVpcId(v string) *VpcConfigOutput

SetVpcId sets the VpcId field's value.

func (VpcConfigOutput) String

func (s VpcConfigOutput) 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".