openapi: 3.2.0 info: title: Amazon Lightsail Contact Methods API description: Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. version: '2016-11-28' contact: name: AWS Support url: https://aws.amazon.com/premiumsupport/ license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html x-logo: url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png x-generated-from: AWS Smithy 2.0 service model (https://github.com/aws/api-models-aws) — mechanical transform, no hand-authored operations servers: - url: https://lightsail.us-east-1.amazonaws.com description: Amazon Lightsail regional endpoint (us-east-1). Lightsail is regional — one endpoint per AWS Region, lightsail.{region}.amazonaws.com (IPv4) or lightsail.{region}.api.aws (dual-stack). See https://docs.aws.amazon.com/general/latest/gr/lightsail.html security: - sigv4: [] tags: - name: Contact Methods paths: /ls/api/2016-11-28/CreateContactMethod: post: operationId: CreateContactMethod summary: Creates an email or SMS text message contact method description: Creates an email or SMS text message contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail . The create contact method operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide . tags: - Contact Methods requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/CreateContactMethodRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/CreateContactMethodResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '428': description: RegionSetupInProgressException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/RegionSetupInProgressException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.CreateContactMethod /ls/api/2016-11-28/DeleteContactMethod: post: operationId: DeleteContactMethod summary: Deletes a contact method description: Deletes a contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail . tags: - Contact Methods requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/DeleteContactMethodRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/DeleteContactMethodResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '428': description: RegionSetupInProgressException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/RegionSetupInProgressException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.DeleteContactMethod /ls/api/2016-11-28/GetContactMethods: get: operationId: GetContactMethods summary: Returns information about the configured contact methods description: Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail . tags: - Contact Methods parameters: - name: protocols in: query required: false schema: $ref: '#/components/schemas/ContactProtocolsList' description: The protocols used to send notifications, such as Email , or SMS (text messaging). Specify a protocol in your request to return information about a specific contact method protocol. responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/GetContactMethodsResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '428': description: RegionSetupInProgressException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/RegionSetupInProgressException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.GetContactMethods /ls/api/2016-11-28/SendContactMethodVerification: post: operationId: SendContactMethodVerification summary: Sends a verification request to an email contact method to ensure it's owned by… description: Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail . A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired. Notifications are not sent to an email contact method until after it is verified, and confirmed as valid. tags: - Contact Methods requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/SendContactMethodVerificationRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/SendContactMethodVerificationResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '428': description: RegionSetupInProgressException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/RegionSetupInProgressException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.SendContactMethodVerification components: schemas: DeleteContactMethodRequest: type: object properties: protocol: allOf: - $ref: '#/components/schemas/ContactProtocol' description: The protocol that will be deleted, such as Email or SMS (text messaging). To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol. required: - protocol CreateContactMethodResult: type: object properties: operations: allOf: - $ref: '#/components/schemas/OperationList' description: An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. ContactMethodVerificationProtocol: type: string enum: - Email ContactMethod: type: object properties: contactEndpoint: allOf: - $ref: '#/components/schemas/NonEmptyString' description: The destination of the contact method, such as an email address or a mobile phone number. status: allOf: - $ref: '#/components/schemas/ContactMethodStatus' description: 'The current status of the contact method. A contact method has the following possible status: PendingVerification - The contact method has not yet been verified, and the verification has not yet expired. Valid - The contact method has been verified. InValid - An attempt was made to verify the contact method, but the verification has expired.' protocol: allOf: - $ref: '#/components/schemas/ContactProtocol' description: The protocol of the contact method, such as email or SMS (text messaging). name: allOf: - $ref: '#/components/schemas/ResourceName' description: The name of the contact method. arn: allOf: - $ref: '#/components/schemas/NonEmptyString' description: The Amazon Resource Name (ARN) of the contact method. createdAt: allOf: - $ref: '#/components/schemas/IsoDate' description: The timestamp when the contact method was created. location: allOf: - $ref: '#/components/schemas/ResourceLocation' description: An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone. resourceType: allOf: - $ref: '#/components/schemas/ResourceType' description: The Lightsail resource type of the contact method. supportCode: allOf: - $ref: '#/components/schemas/string' description: The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily. tags: allOf: - $ref: '#/components/schemas/TagList' description: The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide . description: Describes a contact method. A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail . AccessDeniedException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. ContactMethodsList: type: array items: $ref: '#/components/schemas/ContactMethod' GetContactMethodsResult: type: object properties: contactMethods: allOf: - $ref: '#/components/schemas/ContactMethodsList' description: An array of objects that describe the contact methods. ContactProtocolsList: type: array items: $ref: '#/components/schemas/ContactProtocol' ResourceName: type: string pattern: ^\w[\w\-]*\w$ NotFoundException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when it cannot find a resource. IsoDate: type: string format: date-time RegionSetupInProgressException: type: object properties: code: $ref: '#/components/schemas/string' docs: allOf: - $ref: '#/components/schemas/string' description: Regions and Availability Zones for Lightsail message: $ref: '#/components/schemas/string' tip: allOf: - $ref: '#/components/schemas/string' description: Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again. description: Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up. OperationList: type: array items: $ref: '#/components/schemas/Operation' TagKey: type: string InvalidInputException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia ( us-east-1 ) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources. OperationFailureException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when an operation fails to execute. SendContactMethodVerificationRequest: type: object properties: protocol: allOf: - $ref: '#/components/schemas/ContactMethodVerificationProtocol' description: The protocol to verify, such as Email or SMS (text messaging). required: - protocol ContactMethodStatus: type: string enum: - PendingVerification - Valid - Invalid RegionName: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-north-1 - eu-south-2 - ca-central-1 - ap-east-1 - ap-south-1 - ap-southeast-1 - ap-southeast-2 - ap-northeast-1 - ap-northeast-2 - ap-southeast-3 - ap-southeast-5 - sa-east-1 SendContactMethodVerificationResult: type: object properties: operations: allOf: - $ref: '#/components/schemas/OperationList' description: An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. ResourceType: type: string enum: - ContainerService - Instance - StaticIp - KeyPair - InstanceSnapshot - Domain - PeeredVpc - LoadBalancer - LoadBalancerTlsCertificate - Disk - DiskSnapshot - RelationalDatabase - RelationalDatabaseSnapshot - ExportSnapshotRecord - CloudFormationStackRecord - Alarm - ContactMethod - Distribution - Certificate - Bucket TagList: type: array items: $ref: '#/components/schemas/Tag' Operation: type: object properties: id: allOf: - $ref: '#/components/schemas/NonEmptyString' description: The ID of the operation. resourceName: allOf: - $ref: '#/components/schemas/ResourceName' description: The resource name. resourceType: allOf: - $ref: '#/components/schemas/ResourceType' description: The resource type. createdAt: allOf: - $ref: '#/components/schemas/IsoDate' description: The timestamp when the operation was initialized ( 1479816991.349 ). location: allOf: - $ref: '#/components/schemas/ResourceLocation' description: The Amazon Web Services Region and Availability Zone. isTerminal: allOf: - $ref: '#/components/schemas/boolean' description: A Boolean value indicating whether the operation is terminal. operationDetails: allOf: - $ref: '#/components/schemas/string' description: Details about the operation ( Debian-1GB-Ohio-1 ). operationType: allOf: - $ref: '#/components/schemas/OperationType' description: The type of operation. status: allOf: - $ref: '#/components/schemas/OperationStatus' description: The status of the operation. statusChangedAt: allOf: - $ref: '#/components/schemas/IsoDate' description: The timestamp when the status was changed ( 1479816991.349 ). errorCode: allOf: - $ref: '#/components/schemas/string' description: The error code. errorDetails: allOf: - $ref: '#/components/schemas/string' description: The error details. description: Describes the API operation. string: type: string boolean: type: boolean UnauthenticatedException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when the user has not been authenticated. ResourceLocation: type: object properties: availabilityZone: allOf: - $ref: '#/components/schemas/string' description: The Availability Zone. Follows the format us-east-2a (case-sensitive). regionName: allOf: - $ref: '#/components/schemas/RegionName' description: The Amazon Web Services Region name. description: Describes the resource location. TagValue: type: string Tag: type: object properties: key: allOf: - $ref: '#/components/schemas/TagKey' description: 'The key of the tag. Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @' value: allOf: - $ref: '#/components/schemas/TagValue' description: 'The value of the tag. Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @' description: Describes a tag key and optional value assigned to an Amazon Lightsail resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide . DeleteContactMethodResult: type: object properties: operations: allOf: - $ref: '#/components/schemas/OperationList' description: An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. NonEmptyString: type: string pattern: \S OperationType: type: string enum: - DeleteKnownHostKeys - DeleteInstance - CreateInstance - StopInstance - StartInstance - RebootInstance - OpenInstancePublicPorts - PutInstancePublicPorts - CloseInstancePublicPorts - AllocateStaticIp - ReleaseStaticIp - AttachStaticIp - DetachStaticIp - UpdateDomainEntry - DeleteDomainEntry - CreateDomain - DeleteDomain - CreateInstanceSnapshot - DeleteInstanceSnapshot - CreateInstancesFromSnapshot - CreateLoadBalancer - DeleteLoadBalancer - AttachInstancesToLoadBalancer - DetachInstancesFromLoadBalancer - UpdateLoadBalancerAttribute - CreateLoadBalancerTlsCertificate - DeleteLoadBalancerTlsCertificate - AttachLoadBalancerTlsCertificate - CreateDisk - DeleteDisk - AttachDisk - DetachDisk - CreateDiskSnapshot - DeleteDiskSnapshot - CreateDiskFromSnapshot - CreateRelationalDatabase - UpdateRelationalDatabase - DeleteRelationalDatabase - CreateRelationalDatabaseFromSnapshot - CreateRelationalDatabaseSnapshot - DeleteRelationalDatabaseSnapshot - UpdateRelationalDatabaseParameters - StartRelationalDatabase - RebootRelationalDatabase - StopRelationalDatabase - EnableAddOn - DisableAddOn - PutAlarm - GetAlarms - DeleteAlarm - TestAlarm - CreateContactMethod - GetContactMethods - SendContactMethodVerification - DeleteContactMethod - CreateDistribution - UpdateDistribution - DeleteDistribution - ResetDistributionCache - AttachCertificateToDistribution - DetachCertificateFromDistribution - UpdateDistributionBundle - SetIpAddressType - CreateCertificate - DeleteCertificate - CreateContainerService - UpdateContainerService - DeleteContainerService - CreateContainerServiceDeployment - CreateContainerServiceRegistryLogin - RegisterContainerImage - DeleteContainerImage - CreateBucket - DeleteBucket - CreateBucketAccessKey - DeleteBucketAccessKey - UpdateBucketBundle - UpdateBucket - SetResourceAccessForBucket - UpdateInstanceMetadataOptions - StartGUISession - StopGUISession - SetupInstanceHttps - GetProfile OperationStatus: type: string enum: - NotStarted - Started - Failed - Completed - Succeeded CreateContactMethodRequest: type: object properties: protocol: allOf: - $ref: '#/components/schemas/ContactProtocol' description: The protocol of the contact method, such as Email or SMS (text messaging). The SMS protocol is supported only in the following Amazon Web Services Regions. US East (N. Virginia) ( us-east-1 ) US West (Oregon) ( us-west-2 ) Europe (Ireland) ( eu-west-1 ) Asia Pacific (Tokyo) ( ap-northeast-1 ) Asia Pacific (Singapore) ( ap-southeast-1 ) Asia Pacific (Sydney) ( ap-southeast-2 ) For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide . For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail . contactEndpoint: allOf: - $ref: '#/components/schemas/StringMax256' description: The destination of the contact method, such as an email address or a mobile phone number. Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia . tags: allOf: - $ref: '#/components/schemas/TagList' description: The tag keys and optional values to add to the contact method during create. Use the TagResource action to tag a resource after it's created. required: - protocol - contactEndpoint ContactProtocol: type: string enum: - Email - SMS ServiceException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: A general service exception. StringMax256: type: string minLength: 1 maxLength: 256 securitySchemes: sigv4: type: apiKey name: Authorization in: header description: AWS Signature Version 4. Sign each request with IAM credentials for service name "lightsail"; the Authorization header carries the AWS4-HMAC-SHA256 credential scope, signed headers and signature. Temporary STS credentials additionally require X-Amz-Security-Token. See https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/CommonParameters.html externalDocs: description: Amazon Lightsail API Reference url: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/Welcome.html