- getActiveTracing() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
- getActiveTracing() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
Displays whether this canary run used active AWS X-Ray tracing.
- getArtifactS3Location() - Method in class com.amazonaws.services.synthetics.model.Canary
-
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
- getArtifactS3Location() - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The location where the canary stored artifacts from the run.
- getArtifactS3Location() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
- getCachedResponseMetadata(AmazonWebServiceRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSynthetics
-
- getCachedResponseMetadata(AmazonWebServiceRequest) - Method in interface com.amazonaws.services.synthetics.AWSSynthetics
-
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
- getCachedResponseMetadata(AmazonWebServiceRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsClient
-
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
- getCanaries() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesResult
-
Returns an array.
- getCanariesLastRun() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult
-
An array that contains the information from the most recent run of each canary.
- getCanary(GetCanaryRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSynthetics
-
- getCanary(GetCanaryRequest) - Method in interface com.amazonaws.services.synthetics.AWSSynthetics
-
Retrieves complete information about one canary.
- getCanary(GetCanaryRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsClient
-
Retrieves complete information about one canary.
- getCanary() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryResult
-
The full details about the canary you have created.
- getCanary() - Method in class com.amazonaws.services.synthetics.model.GetCanaryResult
-
A strucure that contains the full information about the canary.
- getCanaryAsync(GetCanaryRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- getCanaryAsync(GetCanaryRequest, AsyncHandler<GetCanaryRequest, GetCanaryResult>) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- getCanaryAsync(GetCanaryRequest) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Retrieves complete information about one canary.
- getCanaryAsync(GetCanaryRequest, AsyncHandler<GetCanaryRequest, GetCanaryResult>) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Retrieves complete information about one canary.
- getCanaryAsync(GetCanaryRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- getCanaryAsync(GetCanaryRequest, AsyncHandler<GetCanaryRequest, GetCanaryResult>) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- getCanaryName() - Method in class com.amazonaws.services.synthetics.model.CanaryLastRun
-
The name of the canary.
- GetCanaryRequest - Class in com.amazonaws.services.synthetics.model
-
- GetCanaryRequest() - Constructor for class com.amazonaws.services.synthetics.model.GetCanaryRequest
-
- GetCanaryResult - Class in com.amazonaws.services.synthetics.model
-
- GetCanaryResult() - Constructor for class com.amazonaws.services.synthetics.model.GetCanaryResult
-
- getCanaryRuns(GetCanaryRunsRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSynthetics
-
- getCanaryRuns(GetCanaryRunsRequest) - Method in interface com.amazonaws.services.synthetics.AWSSynthetics
-
Retrieves a list of runs for a specified canary.
- getCanaryRuns(GetCanaryRunsRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsClient
-
Retrieves a list of runs for a specified canary.
- getCanaryRuns() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
An array of structures.
- getCanaryRunsAsync(GetCanaryRunsRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- getCanaryRunsAsync(GetCanaryRunsRequest, AsyncHandler<GetCanaryRunsRequest, GetCanaryRunsResult>) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- getCanaryRunsAsync(GetCanaryRunsRequest) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Retrieves a list of runs for a specified canary.
- getCanaryRunsAsync(GetCanaryRunsRequest, AsyncHandler<GetCanaryRunsRequest, GetCanaryRunsResult>) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Retrieves a list of runs for a specified canary.
- getCanaryRunsAsync(GetCanaryRunsRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- getCanaryRunsAsync(GetCanaryRunsRequest, AsyncHandler<GetCanaryRunsRequest, GetCanaryRunsResult>) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- GetCanaryRunsRequest - Class in com.amazonaws.services.synthetics.model
-
- GetCanaryRunsRequest() - Constructor for class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
- GetCanaryRunsResult - Class in com.amazonaws.services.synthetics.model
-
- GetCanaryRunsResult() - Constructor for class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
- getCode() - Method in class com.amazonaws.services.synthetics.model.Canary
-
- getCode() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that includes the entry point from which the canary should start running your script.
- getCode() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that includes the entry point from which the canary should start running your script.
- getCompleted() - Method in class com.amazonaws.services.synthetics.model.CanaryRunTimeline
-
The end time of the run.
- getCreated() - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time the canary was created.
- getDeprecationDate() - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
If this runtime version is deprecated, this value is the date of deprecation.
- getDescription() - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
A description of the runtime version, created by Amazon.
- getDurationInSeconds() - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleInput
-
How long, in seconds, for the canary to continue making regular runs according to the schedule in the
Expression value.
- getDurationInSeconds() - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleOutput
-
How long, in seconds, for the canary to continue making regular runs after it was created.
- getEngineArn() - Method in class com.amazonaws.services.synthetics.model.Canary
-
The ARN of the Lambda function that is used as your canary's engine.
- getEnvironmentVariables() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
Specifies the keys and values to use for any environment variables used in the canary script.
- getExecutionRoleArn() - Method in class com.amazonaws.services.synthetics.model.Canary
-
The ARN of the IAM role used to run the canary.
- getExecutionRoleArn() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The ARN of the IAM role to be used to run the canary.
- getExecutionRoleArn() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The ARN of the IAM role to be used to run the canary.
- getExecutorService() - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
Returns the executor service used by this client to execute async requests.
- getExpression() - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleInput
-
A rate expression that defines how often the canary is to run.
- getExpression() - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleOutput
-
A rate expression that defines how often the canary is to run.
- getFailureRetentionPeriodInDays() - Method in class com.amazonaws.services.synthetics.model.Canary
-
The number of days to retain data about failed runs of this canary.
- getFailureRetentionPeriodInDays() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The number of days to retain data about failed runs of this canary.
- getFailureRetentionPeriodInDays() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The number of days to retain data about failed runs of this canary.
- getHandler() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The entry point to use for the source code when running the canary.
- getHandler() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeOutput
-
The entry point to use for the source code when running the canary.
- getId() - Method in class com.amazonaws.services.synthetics.model.Canary
-
The unique ID of this canary.
- getId() - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
A unique ID that identifies this canary run.
- getLastModified() - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time the canary was most recently modified.
- getLastRun() - Method in class com.amazonaws.services.synthetics.model.CanaryLastRun
-
The results from this canary's most recent run.
- getLastStarted() - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time that the canary's most recent run started.
- getLastStopped() - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time that the canary's most recent run ended.
- getMaxResults() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunRequest
-
Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun
operation.
- getMaxResults() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesRequest
-
Specify this parameter to limit how many canaries are returned each time you use the
DescribeCanaries operation.
- getMaxResults() - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsRequest
-
Specify this parameter to limit how many runs are returned each time you use the
DescribeRuntimeVersions operation.
- getMaxResults() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns
operation.
- getMemoryInMB() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
The maximum amount of memory available to the canary while it is running, in MB.
- getMemoryInMB() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
The maximum amount of memory available to the canary while it is running, in MB.
- getName() - Method in class com.amazonaws.services.synthetics.model.Canary
-
The name of the canary.
- getName() - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The name of the canary.
- getName() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The name for this canary.
- getName() - Method in class com.amazonaws.services.synthetics.model.DeleteCanaryRequest
-
The name of the canary that you want to delete.
- getName() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRequest
-
The name of the canary that you want details for.
- getName() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
The name of the canary that you want to see runs for.
- getName() - Method in class com.amazonaws.services.synthetics.model.StartCanaryRequest
-
The name of the canary that you want to run.
- getName() - Method in class com.amazonaws.services.synthetics.model.StopCanaryRequest
-
The name of the canary that you want to stop.
- getName() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The name of the canary that you want to update.
- getNextToken() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunRequest
-
A token that indicates that there is more data available.
- getNextToken() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult
-
A token that indicates that there is more data available.
- getNextToken() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesRequest
-
A token that indicates that there is more data available.
- getNextToken() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesResult
-
A token that indicates that there is more data available.
- getNextToken() - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsRequest
-
A token that indicates that there is more data available.
- getNextToken() - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult
-
A token that indicates that there is more data available.
- getNextToken() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
A token that indicates that there is more data available.
- getNextToken() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
A token that indicates that there is more data available.
- getReleaseDate() - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
The date that the runtime version was released.
- getResourceArn() - Method in class com.amazonaws.services.synthetics.model.ListTagsForResourceRequest
-
The ARN of the canary that you want to view tags for.
- getResourceArn() - Method in class com.amazonaws.services.synthetics.model.TagResourceRequest
-
The ARN of the canary that you're adding tags to.
- getResourceArn() - Method in class com.amazonaws.services.synthetics.model.UntagResourceRequest
-
The ARN of the canary that you're removing tags from.
- getRunConfig() - Method in class com.amazonaws.services.synthetics.model.Canary
-
- getRunConfig() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that contains the configuration for individual canary runs, such as timeout value.
- getRunConfig() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that contains the timeout value that is used for each individual run of the canary.
- getRuntimeVersion() - Method in class com.amazonaws.services.synthetics.model.Canary
-
Specifies the runtime version to use for the canary.
- getRuntimeVersion() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
Specifies the runtime version to use for the canary.
- getRuntimeVersion() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
Specifies the runtime version to use for the canary.
- getRuntimeVersions() - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult
-
An array of objects that display the details about each Synthetics canary runtime version.
- getS3Bucket() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
If your canary script is located in S3, specify the full bucket name here.
- getS3Key() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The S3 key of your script.
- getS3Version() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The S3 version ID of your script.
- getSchedule() - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about how often the canary is to run, and when these runs are to stop.
- getSchedule() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that contains information about how often the canary is to run and when these test runs are to stop.
- getSchedule() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that contains information about how often the canary is to run, and when these runs are to stop.
- getSecurityGroupIds() - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
The IDs of the security groups for this canary.
- getSecurityGroupIds() - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the security groups for this canary.
- getSourceLocationArn() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeOutput
-
The ARN of the Lambda layer where Synthetics stores the canary script code.
- getStarted() - Method in class com.amazonaws.services.synthetics.model.CanaryRunTimeline
-
The start time of the run.
- getState() - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
The current state of the run.
- getState() - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
The current state of the canary.
- getStateReason() - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
If run of the canary failed, this field contains the reason for the error.
- getStateReason() - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
If the canary has insufficient permissions to run, this field provides more details.
- getStateReasonCode() - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
If this value is CANARY_FAILURE, an exception occurred in the canary code.
- getStateReasonCode() - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
If the canary cannot run or has failed, this field displays the reason.
- getStatus() - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about the canary's status.
- getStatus() - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The status of this run.
- getSubnetIds() - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
The IDs of the subnets where this canary is to run.
- getSubnetIds() - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the subnets where this canary is to run.
- getSuccessRetentionPeriodInDays() - Method in class com.amazonaws.services.synthetics.model.Canary
-
The number of days to retain data about successful runs of this canary.
- getSuccessRetentionPeriodInDays() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The number of days to retain data about successful runs of this canary.
- getSuccessRetentionPeriodInDays() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The number of days to retain data about successful runs of this canary.
- getTagKeys() - Method in class com.amazonaws.services.synthetics.model.UntagResourceRequest
-
The list of tag keys to remove from the resource.
- getTags() - Method in class com.amazonaws.services.synthetics.model.Canary
-
The list of key-value pairs that are associated with the canary.
- getTags() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A list of key-value pairs to associate with the canary.
- getTags() - Method in class com.amazonaws.services.synthetics.model.ListTagsForResourceResult
-
The list of tag keys and values associated with the canary that you specified.
- getTags() - Method in class com.amazonaws.services.synthetics.model.TagResourceRequest
-
The list of key-value pairs to associate with the canary.
- getTimeline() - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about when the canary was created, modified, and most recently run.
- getTimeline() - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
A structure that contains the start and end times of this run.
- getTimeoutInSeconds() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
How long the canary is allowed to run before it must stop.
- getTimeoutInSeconds() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
How long the canary is allowed to run before it must stop.
- getVersionName() - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
The name of the runtime version.
- getVpcConfig() - Method in class com.amazonaws.services.synthetics.model.Canary
-
- getVpcConfig() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
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.
- getVpcConfig() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
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.
- getVpcId() - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the VPC where this canary is to run.
- getZipFile() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
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.
- setActiveTracing(Boolean) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
- setActiveTracing(Boolean) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
Displays whether this canary run used active AWS X-Ray tracing.
- setArtifactS3Location(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
- setArtifactS3Location(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The location where the canary stored artifacts from the run.
- setArtifactS3Location(String) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
- setCanaries(Collection<Canary>) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesResult
-
Returns an array.
- setCanariesLastRun(Collection<CanaryLastRun>) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult
-
An array that contains the information from the most recent run of each canary.
- setCanary(Canary) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryResult
-
The full details about the canary you have created.
- setCanary(Canary) - Method in class com.amazonaws.services.synthetics.model.GetCanaryResult
-
A strucure that contains the full information about the canary.
- setCanaryName(String) - Method in class com.amazonaws.services.synthetics.model.CanaryLastRun
-
The name of the canary.
- setCanaryRuns(Collection<CanaryRun>) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
An array of structures.
- setCode(CanaryCodeOutput) - Method in class com.amazonaws.services.synthetics.model.Canary
-
- setCode(CanaryCodeInput) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that includes the entry point from which the canary should start running your script.
- setCode(CanaryCodeInput) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that includes the entry point from which the canary should start running your script.
- setCompleted(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryRunTimeline
-
The end time of the run.
- setCreated(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time the canary was created.
- setDeprecationDate(Date) - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
If this runtime version is deprecated, this value is the date of deprecation.
- setDescription(String) - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
A description of the runtime version, created by Amazon.
- setDurationInSeconds(Long) - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleInput
-
How long, in seconds, for the canary to continue making regular runs according to the schedule in the
Expression value.
- setDurationInSeconds(Long) - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleOutput
-
How long, in seconds, for the canary to continue making regular runs after it was created.
- setEngineArn(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The ARN of the Lambda function that is used as your canary's engine.
- setEnvironmentVariables(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
Specifies the keys and values to use for any environment variables used in the canary script.
- setExecutionRoleArn(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The ARN of the IAM role used to run the canary.
- setExecutionRoleArn(String) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The ARN of the IAM role to be used to run the canary.
- setExecutionRoleArn(String) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The ARN of the IAM role to be used to run the canary.
- setExpression(String) - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleInput
-
A rate expression that defines how often the canary is to run.
- setExpression(String) - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleOutput
-
A rate expression that defines how often the canary is to run.
- setFailureRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The number of days to retain data about failed runs of this canary.
- setFailureRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The number of days to retain data about failed runs of this canary.
- setFailureRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The number of days to retain data about failed runs of this canary.
- setHandler(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The entry point to use for the source code when running the canary.
- setHandler(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeOutput
-
The entry point to use for the source code when running the canary.
- setId(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The unique ID of this canary.
- setId(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
A unique ID that identifies this canary run.
- setLastModified(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time the canary was most recently modified.
- setLastRun(CanaryRun) - Method in class com.amazonaws.services.synthetics.model.CanaryLastRun
-
The results from this canary's most recent run.
- setLastStarted(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time that the canary's most recent run started.
- setLastStopped(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time that the canary's most recent run ended.
- setMaxResults(Integer) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunRequest
-
Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun
operation.
- setMaxResults(Integer) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesRequest
-
Specify this parameter to limit how many canaries are returned each time you use the
DescribeCanaries operation.
- setMaxResults(Integer) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsRequest
-
Specify this parameter to limit how many runs are returned each time you use the
DescribeRuntimeVersions operation.
- setMaxResults(Integer) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns
operation.
- setMemoryInMB(Integer) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
The maximum amount of memory available to the canary while it is running, in MB.
- setMemoryInMB(Integer) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
The maximum amount of memory available to the canary while it is running, in MB.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The name of the canary.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The name of the canary.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The name for this canary.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.DeleteCanaryRequest
-
The name of the canary that you want to delete.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRequest
-
The name of the canary that you want details for.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
The name of the canary that you want to see runs for.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.StartCanaryRequest
-
The name of the canary that you want to run.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.StopCanaryRequest
-
The name of the canary that you want to stop.
- setName(String) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The name of the canary that you want to update.
- setNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunRequest
-
A token that indicates that there is more data available.
- setNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult
-
A token that indicates that there is more data available.
- setNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesRequest
-
A token that indicates that there is more data available.
- setNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesResult
-
A token that indicates that there is more data available.
- setNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsRequest
-
A token that indicates that there is more data available.
- setNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult
-
A token that indicates that there is more data available.
- setNextToken(String) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
A token that indicates that there is more data available.
- setNextToken(String) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
A token that indicates that there is more data available.
- setReleaseDate(Date) - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
The date that the runtime version was released.
- setResourceArn(String) - Method in class com.amazonaws.services.synthetics.model.ListTagsForResourceRequest
-
The ARN of the canary that you want to view tags for.
- setResourceArn(String) - Method in class com.amazonaws.services.synthetics.model.TagResourceRequest
-
The ARN of the canary that you're adding tags to.
- setResourceArn(String) - Method in class com.amazonaws.services.synthetics.model.UntagResourceRequest
-
The ARN of the canary that you're removing tags from.
- setRunConfig(CanaryRunConfigOutput) - Method in class com.amazonaws.services.synthetics.model.Canary
-
- setRunConfig(CanaryRunConfigInput) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that contains the configuration for individual canary runs, such as timeout value.
- setRunConfig(CanaryRunConfigInput) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that contains the timeout value that is used for each individual run of the canary.
- setRuntimeVersion(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
Specifies the runtime version to use for the canary.
- setRuntimeVersion(String) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
Specifies the runtime version to use for the canary.
- setRuntimeVersion(String) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
Specifies the runtime version to use for the canary.
- setRuntimeVersions(Collection<RuntimeVersion>) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult
-
An array of objects that display the details about each Synthetics canary runtime version.
- setS3Bucket(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
If your canary script is located in S3, specify the full bucket name here.
- setS3Key(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The S3 key of your script.
- setS3Version(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The S3 version ID of your script.
- setSchedule(CanaryScheduleOutput) - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about how often the canary is to run, and when these runs are to stop.
- setSchedule(CanaryScheduleInput) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that contains information about how often the canary is to run and when these test runs are to stop.
- setSchedule(CanaryScheduleInput) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that contains information about how often the canary is to run, and when these runs are to stop.
- setSecurityGroupIds(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
The IDs of the security groups for this canary.
- setSecurityGroupIds(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the security groups for this canary.
- setSourceLocationArn(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeOutput
-
The ARN of the Lambda layer where Synthetics stores the canary script code.
- setStarted(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryRunTimeline
-
The start time of the run.
- setState(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
The current state of the run.
- setState(String) - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
The current state of the canary.
- setStateReason(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
If run of the canary failed, this field contains the reason for the error.
- setStateReason(String) - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
If the canary has insufficient permissions to run, this field provides more details.
- setStateReasonCode(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
If this value is CANARY_FAILURE, an exception occurred in the canary code.
- setStateReasonCode(String) - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
If the canary cannot run or has failed, this field displays the reason.
- setStatus(CanaryStatus) - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about the canary's status.
- setStatus(CanaryRunStatus) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The status of this run.
- setSubnetIds(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
The IDs of the subnets where this canary is to run.
- setSubnetIds(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the subnets where this canary is to run.
- setSuccessRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The number of days to retain data about successful runs of this canary.
- setSuccessRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The number of days to retain data about successful runs of this canary.
- setSuccessRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The number of days to retain data about successful runs of this canary.
- setTagKeys(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.UntagResourceRequest
-
The list of tag keys to remove from the resource.
- setTags(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The list of key-value pairs that are associated with the canary.
- setTags(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A list of key-value pairs to associate with the canary.
- setTags(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.ListTagsForResourceResult
-
The list of tag keys and values associated with the canary that you specified.
- setTags(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.TagResourceRequest
-
The list of key-value pairs to associate with the canary.
- setTimeline(CanaryTimeline) - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about when the canary was created, modified, and most recently run.
- setTimeline(CanaryRunTimeline) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
A structure that contains the start and end times of this run.
- setTimeoutInSeconds(Integer) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
How long the canary is allowed to run before it must stop.
- setTimeoutInSeconds(Integer) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
How long the canary is allowed to run before it must stop.
- setVersionName(String) - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
The name of the runtime version.
- setVpcConfig(VpcConfigOutput) - Method in class com.amazonaws.services.synthetics.model.Canary
-
- setVpcConfig(VpcConfigInput) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
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.
- setVpcConfig(VpcConfigInput) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
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.
- setVpcId(String) - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the VPC where this canary is to run.
- setZipFile(ByteBuffer) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
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.
- shutdown() - Method in class com.amazonaws.services.synthetics.AbstractAWSSynthetics
-
- shutdown() - Method in interface com.amazonaws.services.synthetics.AWSSynthetics
-
Shuts down this client object, releasing any resources that might be held open.
- shutdown() - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
Shuts down the client, releasing all managed resources.
- shutdown() - Method in class com.amazonaws.services.synthetics.AWSSyntheticsClient
-
- standard() - Static method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClientBuilder
-
- standard() - Static method in class com.amazonaws.services.synthetics.AWSSyntheticsClientBuilder
-
- startCanary(StartCanaryRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSynthetics
-
- startCanary(StartCanaryRequest) - Method in interface com.amazonaws.services.synthetics.AWSSynthetics
-
Use this operation to run a canary that has already been created.
- startCanary(StartCanaryRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsClient
-
Use this operation to run a canary that has already been created.
- startCanaryAsync(StartCanaryRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- startCanaryAsync(StartCanaryRequest, AsyncHandler<StartCanaryRequest, StartCanaryResult>) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- startCanaryAsync(StartCanaryRequest) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Use this operation to run a canary that has already been created.
- startCanaryAsync(StartCanaryRequest, AsyncHandler<StartCanaryRequest, StartCanaryResult>) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Use this operation to run a canary that has already been created.
- startCanaryAsync(StartCanaryRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- startCanaryAsync(StartCanaryRequest, AsyncHandler<StartCanaryRequest, StartCanaryResult>) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- StartCanaryRequest - Class in com.amazonaws.services.synthetics.model
-
- StartCanaryRequest() - Constructor for class com.amazonaws.services.synthetics.model.StartCanaryRequest
-
- StartCanaryResult - Class in com.amazonaws.services.synthetics.model
-
- StartCanaryResult() - Constructor for class com.amazonaws.services.synthetics.model.StartCanaryResult
-
- stopCanary(StopCanaryRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSynthetics
-
- stopCanary(StopCanaryRequest) - Method in interface com.amazonaws.services.synthetics.AWSSynthetics
-
Stops the canary to prevent all future runs.
- stopCanary(StopCanaryRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsClient
-
Stops the canary to prevent all future runs.
- stopCanaryAsync(StopCanaryRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- stopCanaryAsync(StopCanaryRequest, AsyncHandler<StopCanaryRequest, StopCanaryResult>) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- stopCanaryAsync(StopCanaryRequest) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Stops the canary to prevent all future runs.
- stopCanaryAsync(StopCanaryRequest, AsyncHandler<StopCanaryRequest, StopCanaryResult>) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Stops the canary to prevent all future runs.
- stopCanaryAsync(StopCanaryRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- stopCanaryAsync(StopCanaryRequest, AsyncHandler<StopCanaryRequest, StopCanaryResult>) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- StopCanaryRequest - Class in com.amazonaws.services.synthetics.model
-
- StopCanaryRequest() - Constructor for class com.amazonaws.services.synthetics.model.StopCanaryRequest
-
- StopCanaryResult - Class in com.amazonaws.services.synthetics.model
-
- StopCanaryResult() - Constructor for class com.amazonaws.services.synthetics.model.StopCanaryResult
-
- tagResource(TagResourceRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSynthetics
-
- tagResource(TagResourceRequest) - Method in interface com.amazonaws.services.synthetics.AWSSynthetics
-
Assigns one or more tags (key-value pairs) to the specified canary.
- tagResource(TagResourceRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsClient
-
Assigns one or more tags (key-value pairs) to the specified canary.
- tagResourceAsync(TagResourceRequest) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- tagResourceAsync(TagResourceRequest, AsyncHandler<TagResourceRequest, TagResourceResult>) - Method in class com.amazonaws.services.synthetics.AbstractAWSSyntheticsAsync
-
- tagResourceAsync(TagResourceRequest) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Assigns one or more tags (key-value pairs) to the specified canary.
- tagResourceAsync(TagResourceRequest, AsyncHandler<TagResourceRequest, TagResourceResult>) - Method in interface com.amazonaws.services.synthetics.AWSSyntheticsAsync
-
Assigns one or more tags (key-value pairs) to the specified canary.
- tagResourceAsync(TagResourceRequest) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- tagResourceAsync(TagResourceRequest, AsyncHandler<TagResourceRequest, TagResourceResult>) - Method in class com.amazonaws.services.synthetics.AWSSyntheticsAsyncClient
-
- TagResourceRequest - Class in com.amazonaws.services.synthetics.model
-
- TagResourceRequest() - Constructor for class com.amazonaws.services.synthetics.model.TagResourceRequest
-
- TagResourceResult - Class in com.amazonaws.services.synthetics.model
-
- TagResourceResult() - Constructor for class com.amazonaws.services.synthetics.model.TagResourceResult
-
- toString() - Method in class com.amazonaws.services.synthetics.model.Canary
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryCodeOutput
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryLastRun
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
Returns a string representation of this object.
- toString() - Method in enum com.amazonaws.services.synthetics.model.CanaryRunState
-
- toString() - Method in enum com.amazonaws.services.synthetics.model.CanaryRunStateReasonCode
-
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryRunTimeline
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleInput
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleOutput
-
Returns a string representation of this object.
- toString() - Method in enum com.amazonaws.services.synthetics.model.CanaryState
-
- toString() - Method in enum com.amazonaws.services.synthetics.model.CanaryStateReasonCode
-
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.CreateCanaryResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.DeleteCanaryRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.DeleteCanaryResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.GetCanaryResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.ListTagsForResourceRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.ListTagsForResourceResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.StartCanaryRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.StartCanaryResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.StopCanaryRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.StopCanaryResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.TagResourceRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.TagResourceResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.UntagResourceRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.UntagResourceResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryResult
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
Returns a string representation of this object.
- toString() - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
Returns a string representation of this object.
- withActiveTracing(Boolean) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
- withActiveTracing(Boolean) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
Displays whether this canary run used active AWS X-Ray tracing.
- withArtifactS3Location(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
- withArtifactS3Location(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The location where the canary stored artifacts from the run.
- withArtifactS3Location(String) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
- withCanaries(Canary...) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesResult
-
Returns an array.
- withCanaries(Collection<Canary>) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesResult
-
Returns an array.
- withCanariesLastRun(CanaryLastRun...) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult
-
An array that contains the information from the most recent run of each canary.
- withCanariesLastRun(Collection<CanaryLastRun>) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult
-
An array that contains the information from the most recent run of each canary.
- withCanary(Canary) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryResult
-
The full details about the canary you have created.
- withCanary(Canary) - Method in class com.amazonaws.services.synthetics.model.GetCanaryResult
-
A strucure that contains the full information about the canary.
- withCanaryName(String) - Method in class com.amazonaws.services.synthetics.model.CanaryLastRun
-
The name of the canary.
- withCanaryRuns(CanaryRun...) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
An array of structures.
- withCanaryRuns(Collection<CanaryRun>) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
An array of structures.
- withCode(CanaryCodeOutput) - Method in class com.amazonaws.services.synthetics.model.Canary
-
- withCode(CanaryCodeInput) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that includes the entry point from which the canary should start running your script.
- withCode(CanaryCodeInput) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that includes the entry point from which the canary should start running your script.
- withCompleted(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryRunTimeline
-
The end time of the run.
- withCreated(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time the canary was created.
- withDeprecationDate(Date) - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
If this runtime version is deprecated, this value is the date of deprecation.
- withDescription(String) - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
A description of the runtime version, created by Amazon.
- withDurationInSeconds(Long) - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleInput
-
How long, in seconds, for the canary to continue making regular runs according to the schedule in the
Expression value.
- withDurationInSeconds(Long) - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleOutput
-
How long, in seconds, for the canary to continue making regular runs after it was created.
- withEngineArn(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The ARN of the Lambda function that is used as your canary's engine.
- withEnvironmentVariables(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
Specifies the keys and values to use for any environment variables used in the canary script.
- withExecutionRoleArn(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The ARN of the IAM role used to run the canary.
- withExecutionRoleArn(String) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The ARN of the IAM role to be used to run the canary.
- withExecutionRoleArn(String) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The ARN of the IAM role to be used to run the canary.
- withExpression(String) - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleInput
-
A rate expression that defines how often the canary is to run.
- withExpression(String) - Method in class com.amazonaws.services.synthetics.model.CanaryScheduleOutput
-
A rate expression that defines how often the canary is to run.
- withFailureRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The number of days to retain data about failed runs of this canary.
- withFailureRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The number of days to retain data about failed runs of this canary.
- withFailureRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The number of days to retain data about failed runs of this canary.
- withHandler(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The entry point to use for the source code when running the canary.
- withHandler(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeOutput
-
The entry point to use for the source code when running the canary.
- withId(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The unique ID of this canary.
- withId(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
A unique ID that identifies this canary run.
- withLastModified(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time the canary was most recently modified.
- withLastRun(CanaryRun) - Method in class com.amazonaws.services.synthetics.model.CanaryLastRun
-
The results from this canary's most recent run.
- withLastStarted(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time that the canary's most recent run started.
- withLastStopped(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryTimeline
-
The date and time that the canary's most recent run ended.
- withMaxResults(Integer) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunRequest
-
Specify this parameter to limit how many runs are returned each time you use the DescribeLastRun
operation.
- withMaxResults(Integer) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesRequest
-
Specify this parameter to limit how many canaries are returned each time you use the
DescribeCanaries operation.
- withMaxResults(Integer) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsRequest
-
Specify this parameter to limit how many runs are returned each time you use the
DescribeRuntimeVersions operation.
- withMaxResults(Integer) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns
operation.
- withMemoryInMB(Integer) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
The maximum amount of memory available to the canary while it is running, in MB.
- withMemoryInMB(Integer) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
The maximum amount of memory available to the canary while it is running, in MB.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The name of the canary.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The name of the canary.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The name for this canary.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.DeleteCanaryRequest
-
The name of the canary that you want to delete.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRequest
-
The name of the canary that you want details for.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
The name of the canary that you want to see runs for.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.StartCanaryRequest
-
The name of the canary that you want to run.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.StopCanaryRequest
-
The name of the canary that you want to stop.
- withName(String) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The name of the canary that you want to update.
- withNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunRequest
-
A token that indicates that there is more data available.
- withNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesLastRunResult
-
A token that indicates that there is more data available.
- withNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesRequest
-
A token that indicates that there is more data available.
- withNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeCanariesResult
-
A token that indicates that there is more data available.
- withNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsRequest
-
A token that indicates that there is more data available.
- withNextToken(String) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult
-
A token that indicates that there is more data available.
- withNextToken(String) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsRequest
-
A token that indicates that there is more data available.
- withNextToken(String) - Method in class com.amazonaws.services.synthetics.model.GetCanaryRunsResult
-
A token that indicates that there is more data available.
- withReleaseDate(Date) - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
The date that the runtime version was released.
- withResourceArn(String) - Method in class com.amazonaws.services.synthetics.model.ListTagsForResourceRequest
-
The ARN of the canary that you want to view tags for.
- withResourceArn(String) - Method in class com.amazonaws.services.synthetics.model.TagResourceRequest
-
The ARN of the canary that you're adding tags to.
- withResourceArn(String) - Method in class com.amazonaws.services.synthetics.model.UntagResourceRequest
-
The ARN of the canary that you're removing tags from.
- withRunConfig(CanaryRunConfigOutput) - Method in class com.amazonaws.services.synthetics.model.Canary
-
- withRunConfig(CanaryRunConfigInput) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that contains the configuration for individual canary runs, such as timeout value.
- withRunConfig(CanaryRunConfigInput) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that contains the timeout value that is used for each individual run of the canary.
- withRuntimeVersion(String) - Method in class com.amazonaws.services.synthetics.model.Canary
-
Specifies the runtime version to use for the canary.
- withRuntimeVersion(String) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
Specifies the runtime version to use for the canary.
- withRuntimeVersion(String) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
Specifies the runtime version to use for the canary.
- withRuntimeVersions(RuntimeVersion...) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult
-
An array of objects that display the details about each Synthetics canary runtime version.
- withRuntimeVersions(Collection<RuntimeVersion>) - Method in class com.amazonaws.services.synthetics.model.DescribeRuntimeVersionsResult
-
An array of objects that display the details about each Synthetics canary runtime version.
- withS3Bucket(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
If your canary script is located in S3, specify the full bucket name here.
- withS3Key(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The S3 key of your script.
- withS3Version(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
The S3 version ID of your script.
- withSchedule(CanaryScheduleOutput) - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about how often the canary is to run, and when these runs are to stop.
- withSchedule(CanaryScheduleInput) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A structure that contains information about how often the canary is to run and when these test runs are to stop.
- withSchedule(CanaryScheduleInput) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
A structure that contains information about how often the canary is to run, and when these runs are to stop.
- withSecurityGroupIds(String...) - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
The IDs of the security groups for this canary.
- withSecurityGroupIds(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
The IDs of the security groups for this canary.
- withSecurityGroupIds(String...) - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the security groups for this canary.
- withSecurityGroupIds(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the security groups for this canary.
- withSourceLocationArn(String) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeOutput
-
The ARN of the Lambda layer where Synthetics stores the canary script code.
- withStarted(Date) - Method in class com.amazonaws.services.synthetics.model.CanaryRunTimeline
-
The start time of the run.
- withState(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
The current state of the run.
- withState(CanaryRunState) - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
The current state of the run.
- withState(String) - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
The current state of the canary.
- withState(CanaryState) - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
The current state of the canary.
- withStateReason(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
If run of the canary failed, this field contains the reason for the error.
- withStateReason(String) - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
If the canary has insufficient permissions to run, this field provides more details.
- withStateReasonCode(String) - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
If this value is CANARY_FAILURE, an exception occurred in the canary code.
- withStateReasonCode(CanaryRunStateReasonCode) - Method in class com.amazonaws.services.synthetics.model.CanaryRunStatus
-
If this value is CANARY_FAILURE, an exception occurred in the canary code.
- withStateReasonCode(String) - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
If the canary cannot run or has failed, this field displays the reason.
- withStateReasonCode(CanaryStateReasonCode) - Method in class com.amazonaws.services.synthetics.model.CanaryStatus
-
If the canary cannot run or has failed, this field displays the reason.
- withStatus(CanaryStatus) - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about the canary's status.
- withStatus(CanaryRunStatus) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
The status of this run.
- withSubnetIds(String...) - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
The IDs of the subnets where this canary is to run.
- withSubnetIds(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.VpcConfigInput
-
The IDs of the subnets where this canary is to run.
- withSubnetIds(String...) - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the subnets where this canary is to run.
- withSubnetIds(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the subnets where this canary is to run.
- withSuccessRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The number of days to retain data about successful runs of this canary.
- withSuccessRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
The number of days to retain data about successful runs of this canary.
- withSuccessRetentionPeriodInDays(Integer) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
The number of days to retain data about successful runs of this canary.
- withTagKeys(String...) - Method in class com.amazonaws.services.synthetics.model.UntagResourceRequest
-
The list of tag keys to remove from the resource.
- withTagKeys(Collection<String>) - Method in class com.amazonaws.services.synthetics.model.UntagResourceRequest
-
The list of tag keys to remove from the resource.
- withTags(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.Canary
-
The list of key-value pairs that are associated with the canary.
- withTags(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
A list of key-value pairs to associate with the canary.
- withTags(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.ListTagsForResourceResult
-
The list of tag keys and values associated with the canary that you specified.
- withTags(Map<String, String>) - Method in class com.amazonaws.services.synthetics.model.TagResourceRequest
-
The list of key-value pairs to associate with the canary.
- withTimeline(CanaryTimeline) - Method in class com.amazonaws.services.synthetics.model.Canary
-
A structure that contains information about when the canary was created, modified, and most recently run.
- withTimeline(CanaryRunTimeline) - Method in class com.amazonaws.services.synthetics.model.CanaryRun
-
A structure that contains the start and end times of this run.
- withTimeoutInSeconds(Integer) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigInput
-
How long the canary is allowed to run before it must stop.
- withTimeoutInSeconds(Integer) - Method in class com.amazonaws.services.synthetics.model.CanaryRunConfigOutput
-
How long the canary is allowed to run before it must stop.
- withVersionName(String) - Method in class com.amazonaws.services.synthetics.model.RuntimeVersion
-
The name of the runtime version.
- withVpcConfig(VpcConfigOutput) - Method in class com.amazonaws.services.synthetics.model.Canary
-
- withVpcConfig(VpcConfigInput) - Method in class com.amazonaws.services.synthetics.model.CreateCanaryRequest
-
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.
- withVpcConfig(VpcConfigInput) - Method in class com.amazonaws.services.synthetics.model.UpdateCanaryRequest
-
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.
- withVpcId(String) - Method in class com.amazonaws.services.synthetics.model.VpcConfigOutput
-
The IDs of the VPC where this canary is to run.
- withZipFile(ByteBuffer) - Method in class com.amazonaws.services.synthetics.model.CanaryCodeInput
-
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.