prowler-sdk-poc
Version:
660 lines • 13.9 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2017-10-11",
"endpointPrefix": "synthetics",
"jsonVersion": "1.1",
"protocol": "rest-json",
"serviceAbbreviation": "Synthetics",
"serviceFullName": "Synthetics",
"serviceId": "synthetics",
"signatureVersion": "v4",
"signingName": "synthetics",
"uid": "synthetics-2017-10-11"
},
"operations": {
"CreateCanary": {
"http": {
"requestUri": "/canary"
},
"input": {
"type": "structure",
"required": [
"Name",
"Code",
"ArtifactS3Location",
"ExecutionRoleArn",
"Schedule",
"RuntimeVersion"
],
"members": {
"Name": {},
"Code": {
"shape": "S3"
},
"ArtifactS3Location": {},
"ExecutionRoleArn": {},
"Schedule": {
"shape": "S7"
},
"RunConfig": {
"shape": "S9"
},
"SuccessRetentionPeriodInDays": {
"type": "integer"
},
"FailureRetentionPeriodInDays": {
"type": "integer"
},
"RuntimeVersion": {},
"VpcConfig": {
"shape": "Sh"
},
"Tags": {
"shape": "Sm"
},
"ArtifactConfig": {
"shape": "Sp"
}
}
},
"output": {
"type": "structure",
"members": {
"Canary": {
"shape": "Su"
}
}
}
},
"DeleteCanary": {
"http": {
"method": "DELETE",
"requestUri": "/canary/{name}"
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {
"location": "uri",
"locationName": "name"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DescribeCanaries": {
"http": {
"requestUri": "/canaries"
},
"input": {
"type": "structure",
"members": {
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"Canaries": {
"type": "list",
"member": {
"shape": "Su"
}
},
"NextToken": {}
}
}
},
"DescribeCanariesLastRun": {
"http": {
"requestUri": "/canaries/last-run"
},
"input": {
"type": "structure",
"members": {
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"CanariesLastRun": {
"type": "list",
"member": {
"type": "structure",
"members": {
"CanaryName": {},
"LastRun": {
"shape": "S1p"
}
}
}
},
"NextToken": {}
}
}
},
"DescribeRuntimeVersions": {
"http": {
"requestUri": "/runtime-versions"
},
"input": {
"type": "structure",
"members": {
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"RuntimeVersions": {
"type": "list",
"member": {
"type": "structure",
"members": {
"VersionName": {},
"Description": {},
"ReleaseDate": {
"type": "timestamp"
},
"DeprecationDate": {
"type": "timestamp"
}
}
}
},
"NextToken": {}
}
}
},
"GetCanary": {
"http": {
"method": "GET",
"requestUri": "/canary/{name}"
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {
"location": "uri",
"locationName": "name"
}
}
},
"output": {
"type": "structure",
"members": {
"Canary": {
"shape": "Su"
}
}
}
},
"GetCanaryRuns": {
"http": {
"requestUri": "/canary/{name}/runs"
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {
"location": "uri",
"locationName": "name"
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"CanaryRuns": {
"type": "list",
"member": {
"shape": "S1p"
}
},
"NextToken": {}
}
}
},
"ListTagsForResource": {
"http": {
"method": "GET",
"requestUri": "/tags/{resourceArn}"
},
"input": {
"type": "structure",
"required": [
"ResourceArn"
],
"members": {
"ResourceArn": {
"location": "uri",
"locationName": "resourceArn"
}
}
},
"output": {
"type": "structure",
"members": {
"Tags": {
"shape": "Sm"
}
}
}
},
"StartCanary": {
"http": {
"requestUri": "/canary/{name}/start"
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {
"location": "uri",
"locationName": "name"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"StopCanary": {
"http": {
"requestUri": "/canary/{name}/stop"
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {
"location": "uri",
"locationName": "name"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"TagResource": {
"http": {
"requestUri": "/tags/{resourceArn}"
},
"input": {
"type": "structure",
"required": [
"ResourceArn",
"Tags"
],
"members": {
"ResourceArn": {
"location": "uri",
"locationName": "resourceArn"
},
"Tags": {
"shape": "Sm"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"UntagResource": {
"http": {
"method": "DELETE",
"requestUri": "/tags/{resourceArn}"
},
"input": {
"type": "structure",
"required": [
"ResourceArn",
"TagKeys"
],
"members": {
"ResourceArn": {
"location": "uri",
"locationName": "resourceArn"
},
"TagKeys": {
"location": "querystring",
"locationName": "tagKeys",
"type": "list",
"member": {}
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"UpdateCanary": {
"http": {
"method": "PATCH",
"requestUri": "/canary/{name}"
},
"input": {
"type": "structure",
"required": [
"Name"
],
"members": {
"Name": {
"location": "uri",
"locationName": "name"
},
"Code": {
"shape": "S3"
},
"ExecutionRoleArn": {},
"RuntimeVersion": {},
"Schedule": {
"shape": "S7"
},
"RunConfig": {
"shape": "S9"
},
"SuccessRetentionPeriodInDays": {
"type": "integer"
},
"FailureRetentionPeriodInDays": {
"type": "integer"
},
"VpcConfig": {
"shape": "Sh"
},
"VisualReference": {
"type": "structure",
"required": [
"BaseCanaryRunId"
],
"members": {
"BaseScreenshots": {
"shape": "S18"
},
"BaseCanaryRunId": {}
}
},
"ArtifactS3Location": {},
"ArtifactConfig": {
"shape": "Sp"
}
}
},
"output": {
"type": "structure",
"members": {}
}
}
},
"shapes": {
"S3": {
"type": "structure",
"required": [
"Handler"
],
"members": {
"S3Bucket": {},
"S3Key": {},
"S3Version": {},
"ZipFile": {
"type": "blob"
},
"Handler": {}
}
},
"S7": {
"type": "structure",
"required": [
"Expression"
],
"members": {
"Expression": {},
"DurationInSeconds": {
"type": "long"
}
}
},
"S9": {
"type": "structure",
"members": {
"TimeoutInSeconds": {
"type": "integer"
},
"MemoryInMB": {
"type": "integer"
},
"ActiveTracing": {
"type": "boolean"
},
"EnvironmentVariables": {
"type": "map",
"key": {},
"value": {}
}
}
},
"Sh": {
"type": "structure",
"members": {
"SubnetIds": {
"shape": "Si"
},
"SecurityGroupIds": {
"shape": "Sk"
}
}
},
"Si": {
"type": "list",
"member": {}
},
"Sk": {
"type": "list",
"member": {}
},
"Sm": {
"type": "map",
"key": {},
"value": {}
},
"Sp": {
"type": "structure",
"members": {
"S3Encryption": {
"shape": "Sq"
}
}
},
"Sq": {
"type": "structure",
"members": {
"EncryptionMode": {},
"KmsKeyArn": {}
}
},
"Su": {
"type": "structure",
"members": {
"Id": {},
"Name": {},
"Code": {
"type": "structure",
"members": {
"SourceLocationArn": {},
"Handler": {}
}
},
"ExecutionRoleArn": {},
"Schedule": {
"type": "structure",
"members": {
"Expression": {},
"DurationInSeconds": {
"type": "long"
}
}
},
"RunConfig": {
"type": "structure",
"members": {
"TimeoutInSeconds": {
"type": "integer"
},
"MemoryInMB": {
"type": "integer"
},
"ActiveTracing": {
"type": "boolean"
}
}
},
"SuccessRetentionPeriodInDays": {
"type": "integer"
},
"FailureRetentionPeriodInDays": {
"type": "integer"
},
"Status": {
"type": "structure",
"members": {
"State": {},
"StateReason": {},
"StateReasonCode": {}
}
},
"Timeline": {
"type": "structure",
"members": {
"Created": {
"type": "timestamp"
},
"LastModified": {
"type": "timestamp"
},
"LastStarted": {
"type": "timestamp"
},
"LastStopped": {
"type": "timestamp"
}
}
},
"ArtifactS3Location": {},
"EngineArn": {},
"RuntimeVersion": {},
"VpcConfig": {
"type": "structure",
"members": {
"VpcId": {},
"SubnetIds": {
"shape": "Si"
},
"SecurityGroupIds": {
"shape": "Sk"
}
}
},
"VisualReference": {
"type": "structure",
"members": {
"BaseScreenshots": {
"shape": "S18"
},
"BaseCanaryRunId": {}
}
},
"Tags": {
"shape": "Sm"
},
"ArtifactConfig": {
"type": "structure",
"members": {
"S3Encryption": {
"shape": "Sq"
}
}
}
}
},
"S18": {
"type": "list",
"member": {
"type": "structure",
"required": [
"ScreenshotName"
],
"members": {
"ScreenshotName": {},
"IgnoreCoordinates": {
"type": "list",
"member": {}
}
}
}
},
"S1p": {
"type": "structure",
"members": {
"Id": {},
"Name": {},
"Status": {
"type": "structure",
"members": {
"State": {},
"StateReason": {},
"StateReasonCode": {}
}
},
"Timeline": {
"type": "structure",
"members": {
"Started": {
"type": "timestamp"
},
"Completed": {
"type": "timestamp"
}
}
},
"ArtifactS3Location": {}
}
}
}
}