Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Canary

type Canary struct {

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

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

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

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

	// The number of days to retain data about failed runs of this canary.
	FailureRetentionPeriodInDays *int32

	// The unique ID of this canary.
	Id *string

	// The name of the canary.
	Name *string

	// A structure that contains information about a canary run.
	RunConfig *CanaryRunConfigOutput

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

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

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

	// The number of days to retain data about successful runs of this canary.
	SuccessRetentionPeriodInDays *int32

	// The list of key-value pairs that are associated with the canary.
	Tags map[string]string

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

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

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

    type CanaryCodeInput

    type CanaryCodeInput struct {
    
    	// The entry point to use for the source code when running the canary. This value
    	// must end with the string .handler.
    	//
    	// This member is required.
    	Handler *string
    
    	// If your canary script is located in S3, specify the full bucket name here. The
    	// bucket must already exist. Specify the full bucket name, including s3:// as the
    	// start of the bucket name.
    	S3Bucket *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
    
    	// The S3 version ID of your script.
    	S3Version *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 .zip file that contains the
    	// script. It can be up to 5 MB.
    	ZipFile []byte
    }

      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.

      type CanaryCodeOutput

      type CanaryCodeOutput struct {
      
      	// The entry point to use for the source code when running the canary.
      	Handler *string
      
      	// The ARN of the Lambda layer where Synthetics stores the canary script code.
      	SourceLocationArn *string
      }

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

        type CanaryLastRun

        type CanaryLastRun struct {
        
        	// The name of the canary.
        	CanaryName *string
        
        	// The results from this canary's most recent run.
        	LastRun *CanaryRun
        }

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

          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
          
          	// A unique ID that identifies this canary run.
          	Id *string
          
          	// The name of the canary.
          	Name *string
          
          	// The status of this run.
          	Status *CanaryRunStatus
          
          	// A structure that contains the start and end times of this run.
          	Timeline *CanaryRunTimeline
          }

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

            type CanaryRunConfigInput

            type CanaryRunConfigInput struct {
            
            	// Specifies whether this canary is to use active AWS 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
            
            	// 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).
            	EnvironmentVariables map[string]string
            
            	// The maximum amount of memory available to the canary while it is running, in MB.
            	// This value must be a multiple of 64.
            	MemoryInMB *int32
            
            	// 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 *int32
            }

              A structure that contains input information for a canary run.

              type CanaryRunConfigOutput

              type CanaryRunConfigOutput struct {
              
              	// Displays whether this canary run used active AWS X-Ray tracing.
              	ActiveTracing *bool
              
              	// The maximum amount of memory available to the canary while it is running, in MB.
              	// This value must be a multiple of 64.
              	MemoryInMB *int32
              
              	// How long the canary is allowed to run before it must stop.
              	TimeoutInSeconds *int32
              }

                A structure that contains information about a canary run.

                type CanaryRunState

                type CanaryRunState string
                const (
                	CanaryRunStateRunning CanaryRunState = "RUNNING"
                	CanaryRunStatePassed  CanaryRunState = "PASSED"
                	CanaryRunStateFailed  CanaryRunState = "FAILED"
                )

                  Enum values for CanaryRunState

                  func (CanaryRunState) Values

                  func (CanaryRunState) Values() []CanaryRunState

                    Values returns all known values for CanaryRunState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                    type CanaryRunStateReasonCode

                    type CanaryRunStateReasonCode string
                    const (
                    	CanaryRunStateReasonCodeCanaryFailure    CanaryRunStateReasonCode = "CANARY_FAILURE"
                    	CanaryRunStateReasonCodeExecutionFailure CanaryRunStateReasonCode = "EXECUTION_FAILURE"
                    )

                      Enum values for CanaryRunStateReasonCode

                      func (CanaryRunStateReasonCode) Values

                        Values returns all known values for CanaryRunStateReasonCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                        type CanaryRunStatus

                        type CanaryRunStatus struct {
                        
                        	// The current state of the run.
                        	State CanaryRunState
                        
                        	// If run of the canary failed, this field contains the reason for the error.
                        	StateReason *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 CanaryRunStateReasonCode
                        }

                          This structure contains the status information about a canary run.

                          type CanaryRunTimeline

                          type CanaryRunTimeline struct {
                          
                          	// The end time of the run.
                          	Completed *time.Time
                          
                          	// The start time of the run.
                          	Started *time.Time
                          }

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

                            type CanaryScheduleInput

                            type CanaryScheduleInput struct {
                            
                            	// A rate expression that defines how often the canary is to run. 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.
                            	//
                            	// This member is required.
                            	Expression *string
                            
                            	// 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
                            }

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

                              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
                              
                              	// A rate expression that defines how often the canary is to run. 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. Specifying rate(0 minute) or
                              	// rate(0 hour) is a special value that causes the canary to run only once when it
                              	// is started.
                              	Expression *string
                              }

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

                                type CanaryState

                                type CanaryState string
                                const (
                                	CanaryStateCreating CanaryState = "CREATING"
                                	CanaryStateReady    CanaryState = "READY"
                                	CanaryStateStarting CanaryState = "STARTING"
                                	CanaryStateRunning  CanaryState = "RUNNING"
                                	CanaryStateUpdating CanaryState = "UPDATING"
                                	CanaryStateStopping CanaryState = "STOPPING"
                                	CanaryStateStopped  CanaryState = "STOPPED"
                                	CanaryStateError    CanaryState = "ERROR"
                                	CanaryStateDeleting CanaryState = "DELETING"
                                )

                                  Enum values for CanaryState

                                  func (CanaryState) Values

                                  func (CanaryState) Values() []CanaryState

                                    Values returns all known values for CanaryState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                    type CanaryStateReasonCode

                                    type CanaryStateReasonCode string
                                    const (
                                    	CanaryStateReasonCodeInvalidPermissions CanaryStateReasonCode = "INVALID_PERMISSIONS"
                                    )

                                      Enum values for CanaryStateReasonCode

                                      func (CanaryStateReasonCode) Values

                                        Values returns all known values for CanaryStateReasonCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                        type CanaryStatus

                                        type CanaryStatus struct {
                                        
                                        	// The current state of the canary.
                                        	State CanaryState
                                        
                                        	// If the canary has insufficient permissions to run, this field provides more
                                        	// details.
                                        	StateReason *string
                                        
                                        	// If the canary cannot run or has failed, this field displays the reason.
                                        	StateReasonCode CanaryStateReasonCode
                                        }

                                          A structure that contains the current state of the canary.

                                          type CanaryTimeline

                                          type CanaryTimeline struct {
                                          
                                          	// The date and time the canary was created.
                                          	Created *time.Time
                                          
                                          	// The date and time the canary was most recently modified.
                                          	LastModified *time.Time
                                          
                                          	// The date and time that the canary's most recent run started.
                                          	LastStarted *time.Time
                                          
                                          	// The date and time that the canary's most recent run ended.
                                          	LastStopped *time.Time
                                          }

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

                                            type ConflictException

                                            type ConflictException struct {
                                            	Message *string
                                            }

                                              A conflicting operation is already in progress.

                                              func (*ConflictException) Error

                                              func (e *ConflictException) Error() string

                                              func (*ConflictException) ErrorCode

                                              func (e *ConflictException) ErrorCode() string

                                              func (*ConflictException) ErrorFault

                                              func (e *ConflictException) ErrorFault() smithy.ErrorFault

                                              func (*ConflictException) ErrorMessage

                                              func (e *ConflictException) ErrorMessage() string

                                              type InternalServerException

                                              type InternalServerException struct {
                                              	Message *string
                                              }

                                                An unknown internal error occurred.

                                                func (*InternalServerException) Error

                                                func (e *InternalServerException) Error() string

                                                func (*InternalServerException) ErrorCode

                                                func (e *InternalServerException) ErrorCode() string

                                                func (*InternalServerException) ErrorFault

                                                func (e *InternalServerException) ErrorFault() smithy.ErrorFault

                                                func (*InternalServerException) ErrorMessage

                                                func (e *InternalServerException) ErrorMessage() string

                                                type ResourceNotFoundException

                                                type ResourceNotFoundException struct {
                                                	Message *string
                                                }

                                                  One of the specified resources was not found.

                                                  func (*ResourceNotFoundException) Error

                                                  func (e *ResourceNotFoundException) Error() string

                                                  func (*ResourceNotFoundException) ErrorCode

                                                  func (e *ResourceNotFoundException) ErrorCode() string

                                                  func (*ResourceNotFoundException) ErrorFault

                                                  func (*ResourceNotFoundException) ErrorMessage

                                                  func (e *ResourceNotFoundException) ErrorMessage() string

                                                  type RuntimeVersion

                                                  type RuntimeVersion struct {
                                                  
                                                  	// If this runtime version is deprecated, this value is the date of deprecation.
                                                  	DeprecationDate *time.Time
                                                  
                                                  	// A description of the runtime version, created by Amazon.
                                                  	Description *string
                                                  
                                                  	// The date that the runtime version was released.
                                                  	ReleaseDate *time.Time
                                                  
                                                  	// 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
                                                  }

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

                                                    type ValidationException

                                                    type ValidationException struct {
                                                    	Message *string
                                                    }

                                                      A parameter could not be validated.

                                                      func (*ValidationException) Error

                                                      func (e *ValidationException) Error() string

                                                      func (*ValidationException) ErrorCode

                                                      func (e *ValidationException) ErrorCode() string

                                                      func (*ValidationException) ErrorFault

                                                      func (e *ValidationException) ErrorFault() smithy.ErrorFault

                                                      func (*ValidationException) ErrorMessage

                                                      func (e *ValidationException) ErrorMessage() string

                                                      type VpcConfigInput

                                                      type VpcConfigInput struct {
                                                      
                                                      	// The IDs of the security groups for this canary.
                                                      	SecurityGroupIds []string
                                                      
                                                      	// The IDs of the subnets where this canary is to run.
                                                      	SubnetIds []string
                                                      }

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

                                                        type VpcConfigOutput

                                                        type VpcConfigOutput struct {
                                                        
                                                        	// The IDs of the security groups for this canary.
                                                        	SecurityGroupIds []string
                                                        
                                                        	// The IDs of the subnets where this canary is to run.
                                                        	SubnetIds []string
                                                        
                                                        	// The IDs of the VPC where this canary is to run.
                                                        	VpcId *string
                                                        }

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