A configuration for a set of security-related HTTP response headers.
" } }, + "ResponseHeadersPolicyServerTimingHeadersConfig": { + "base": "A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
You can use the Server-Timing header to view metrics that can help you gain insights about the behavior and performance of CloudFront. For example, you can see which cache layer served a cache hit, or the first byte latency from the origin when there was a cache miss. You can use the metrics in the Server-Timing header to troubleshoot issues or test the efficiency of your CloudFront configuration. For more information, see Server-Timing header in the Amazon CloudFront Developer Guide.
A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront.
Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header’s value.
For more information about the Strict-Transport-Security HTTP response header, see Strict-Transport-Security in the MDN Web Docs.
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.
vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.
static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.
A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.
A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
", "refs": { @@ -3148,6 +3160,7 @@ "ResponseHeadersPolicyCustomHeader$Override": "A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here.
", "ResponseHeadersPolicyFrameOptions$Override": "A Boolean that determines whether CloudFront overrides the X-Frame-Options HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
A Boolean that determines whether CloudFront overrides the Strict-Transport-Security HTTP response header received from the origin with the one specified in this response headers policy.
A Boolean that determines whether CloudFront includes the includeSubDomains directive in the Strict-Transport-Security HTTP response header.
A Boolean that determines whether CloudFront includes the preload directive in the Strict-Transport-Security HTTP response header.
Deletes a specified batch of versions of a table.
", "BatchGetBlueprints": "Retrieves information about a list of blueprints.
", "BatchGetCrawlers": "Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves the details for the custom patterns specified by a list of names.
", "BatchGetDevEndpoints": "Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
Retrieves partitions in a batch request.
", @@ -24,7 +24,7 @@ "CreateClassifier": "Creates a classifier in the user's account. This can be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.
Creates a connection definition in the Data Catalog.
", "CreateCrawler": "Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.
", "CreateDatabase": "Creates a new database in a Data Catalog.
", "CreateDevEndpoint": "Creates a new development endpoint.
", "CreateJob": "Creates a new job definition.
", @@ -46,7 +46,7 @@ "DeleteColumnStatisticsForTable": "Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is DeleteTable.
Deletes a connection from the Data Catalog.
", "DeleteCrawler": "Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING.
Deletes a custom pattern by specifying its name.
", "DeleteDatabase": "Removes a specified database from a Data Catalog.
After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database.
Deletes a specified development endpoint.
", "DeleteJob": "Deletes a specified job definition. If the job definition is not found, no exception is thrown.
", @@ -77,7 +77,7 @@ "GetCrawler": "Retrieves metadata for a specified crawler.
", "GetCrawlerMetrics": "Retrieves metrics about specified crawlers.
", "GetCrawlers": "Retrieves metadata for all crawlers defined in the customer account.
", - "GetCustomEntityType": null, + "GetCustomEntityType": "Retrieves the details of a custom pattern by specifying its name.
", "GetDataCatalogEncryptionSettings": "Retrieves the security configuration for a specified catalog.
", "GetDatabase": "Retrieves the definition of a specified database.
", "GetDatabases": "Retrieves all databases defined in a given Data Catalog.
", @@ -128,7 +128,7 @@ "ImportCatalogToGlue": "Imports an existing Amazon Athena Data Catalog to Glue.
", "ListBlueprints": "Lists all the blueprint names in an account.
", "ListCrawlers": "Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Lists all the custom patterns that have been created.
", "ListDevEndpoints": "Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.
Required for cross account crawls. For same account crawls as the target data, this can be left as null.
" } }, "Action": { @@ -1138,9 +1138,9 @@ "ContextWords": { "base": null, "refs": { - "CreateCustomEntityTypeRequest$ContextWords": null, - "CustomEntityType$ContextWords": null, - "GetCustomEntityTypeResponse$ContextWords": null + "CreateCustomEntityTypeRequest$ContextWords": "A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
", + "CustomEntityType$ContextWords": "A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
", + "GetCustomEntityTypeResponse$ContextWords": "A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
" } }, "Crawl": { @@ -1540,7 +1540,7 @@ } }, "CustomEntityType": { - "base": null, + "base": "An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.
", "refs": { "CustomEntityTypes$member": null } @@ -1548,15 +1548,15 @@ "CustomEntityTypeNames": { "base": null, "refs": { - "BatchGetCustomEntityTypesRequest$Names": null, - "BatchGetCustomEntityTypesResponse$CustomEntityTypesNotFound": null + "BatchGetCustomEntityTypesRequest$Names": "A list of names of the custom patterns that you want to retrieve.
", + "BatchGetCustomEntityTypesResponse$CustomEntityTypesNotFound": "A list of the names of custom patterns that were not found.
" } }, "CustomEntityTypes": { "base": null, "refs": { - "BatchGetCustomEntityTypesResponse$CustomEntityTypes": null, - "ListCustomEntityTypesResponse$CustomEntityTypes": null + "BatchGetCustomEntityTypesResponse$CustomEntityTypes": "A list of CustomEntityType objects representing the custom patterns that have been created.
A list of CustomEntityType objects representing custom patterns.
Specifies AWS Lake Formation configuration settings for the crawler.
", "refs": { - "Crawler$LakeFormationConfiguration": null, + "Crawler$LakeFormationConfiguration": "Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
", "CreateCrawlerRequest$LakeFormationConfiguration": null, "UpdateCrawlerRequest$LakeFormationConfiguration": null } @@ -3873,9 +3873,9 @@ "CreateBlueprintResponse$Name": "Returns the name of the blueprint that was registered.
", "CreateCrawlerRequest$Name": "Name of the new crawler.
", "CreateCsvClassifierRequest$Name": "The name of the classifier.
", - "CreateCustomEntityTypeRequest$Name": null, - "CreateCustomEntityTypeRequest$RegexString": null, - "CreateCustomEntityTypeResponse$Name": null, + "CreateCustomEntityTypeRequest$Name": "A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
", + "CreateCustomEntityTypeRequest$RegexString": "A regular expression string that is used for detecting sensitive data in a custom pattern.
", + "CreateCustomEntityTypeResponse$Name": "The name of the custom pattern you created.
", "CreateDevEndpointRequest$SecurityConfiguration": "The name of the SecurityConfiguration structure to be used with this DevEndpoint.
The name of the SecurityConfiguration structure being used with this DevEndpoint.
The name of the new classifier.
", @@ -3902,8 +3902,8 @@ "CreateXMLClassifierRequest$Name": "The name of the classifier.
", "CsvClassifier$Name": "The name of the classifier.
", "CsvHeader$member": null, - "CustomEntityType$Name": null, - "CustomEntityType$RegexString": null, + "CustomEntityType$Name": "A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
", + "CustomEntityType$RegexString": "A regular expression string that is used for detecting sensitive data in a custom pattern.
", "CustomEntityTypeNames$member": null, "Database$Name": "The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
", "DatabaseIdentifier$DatabaseName": "The name of the catalog database.
", @@ -3920,8 +3920,8 @@ "DeleteConnectionNameList$member": null, "DeleteConnectionRequest$ConnectionName": "The name of the connection to delete.
", "DeleteCrawlerRequest$Name": "The name of the crawler to remove.
", - "DeleteCustomEntityTypeRequest$Name": null, - "DeleteCustomEntityTypeResponse$Name": null, + "DeleteCustomEntityTypeRequest$Name": "The name of the custom pattern that you want to delete.
", + "DeleteCustomEntityTypeResponse$Name": "The name of the custom pattern you deleted.
", "DeleteDatabaseRequest$Name": "The name of the database to delete. For Hive compatibility, this must be all lowercase.
", "DeleteJobRequest$JobName": "The name of the job definition to delete.
", "DeleteJobResponse$JobName": "The name of the job definition that was deleted.
", @@ -3961,9 +3961,9 @@ "GetColumnStatisticsForTableRequest$TableName": "The name of the partitions' table.
", "GetConnectionRequest$Name": "The name of the connection definition to retrieve.
", "GetCrawlerRequest$Name": "The name of the crawler to retrieve metadata for.
", - "GetCustomEntityTypeRequest$Name": null, - "GetCustomEntityTypeResponse$Name": null, - "GetCustomEntityTypeResponse$RegexString": null, + "GetCustomEntityTypeRequest$Name": "The name of the custom pattern that you want to retrieve.
", + "GetCustomEntityTypeResponse$Name": "The name of the custom pattern that you retrieved.
", + "GetCustomEntityTypeResponse$RegexString": "A regular expression string that is used for detecting sensitive data in a custom pattern.
", "GetDatabaseRequest$Name": "The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
", "GetJobRequest$JobName": "The name of the job definition to retrieve.
", "GetJobRunRequest$JobName": "Name of the job definition being run.
", @@ -4230,7 +4230,7 @@ "GetWorkflowRequest$IncludeGraph": "Specifies whether to include a graph when returning the workflow resource metadata.
", "GetWorkflowRunRequest$IncludeGraph": "Specifies whether to include the workflow graph in response or not.
", "GetWorkflowRunsRequest$IncludeGraph": "Specifies whether to include the workflow graph in response or not.
", - "LakeFormationConfiguration$UseLakeFormationCredentials": null, + "LakeFormationConfiguration$UseLakeFormationCredentials": "Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
", "MongoDBTarget$ScanAll": "Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.
Specifies not to trim values before identifying the type of column values. The default value is true.
", "UpdateCsvClassifierRequest$AllowSingleColumn": "Enables the processing of files that contain only one column.
" @@ -4412,7 +4412,7 @@ "GetWorkflowRunsRequest$MaxResults": "The maximum number of workflow runs to be included in the response.
", "ListBlueprintsRequest$MaxResults": "The maximum size of a list to return.
", "ListCrawlersRequest$MaxResults": "The maximum size of a list to return.
", - "ListCustomEntityTypesRequest$MaxResults": null, + "ListCustomEntityTypesRequest$MaxResults": "The maximum number of results to return.
", "ListDevEndpointsRequest$MaxResults": "The maximum size of a list to return.
", "ListJobsRequest$MaxResults": "The maximum size of a list to return.
", "ListMLTransformsRequest$MaxResults": "The maximum size of a list to return.
", @@ -4429,8 +4429,8 @@ "GetMLTaskRunsResponse$NextToken": "A pagination token, if more results are available.
", "GetMLTransformsRequest$NextToken": "A paginated token to offset the results.
", "GetMLTransformsResponse$NextToken": "A pagination token, if more results are available.
", - "ListCustomEntityTypesRequest$NextToken": null, - "ListCustomEntityTypesResponse$NextToken": null, + "ListCustomEntityTypesRequest$NextToken": "A paginated token to offset the results.
", + "ListCustomEntityTypesResponse$NextToken": "A pagination token, if more results are available.
", "ListMLTransformsRequest$NextToken": "A continuation token, if this is a continuation request.
", "ListMLTransformsResponse$NextToken": "A continuation token, if the returned list does not contain the last metric available.
" } diff --git a/models/apis/ivschat/2020-07-14/api-2.json b/models/apis/ivschat/2020-07-14/api-2.json new file mode 100644 index 00000000000..211ffd7172c --- /dev/null +++ b/models/apis/ivschat/2020-07-14/api-2.json @@ -0,0 +1,767 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-07-14", + "endpointPrefix":"ivschat", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"ivschat", + "serviceFullName":"Amazon Interactive Video Service Chat", + "serviceId":"ivschat", + "signatureVersion":"v4", + "signingName":"ivschat", + "uid":"ivschat-2020-07-14" + }, + "operations":{ + "CreateChatToken":{ + "name":"CreateChatToken", + "http":{ + "method":"POST", + "requestUri":"/CreateChatToken", + "responseCode":200 + }, + "input":{"shape":"CreateChatTokenRequest"}, + "output":{"shape":"CreateChatTokenResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ] + }, + "CreateRoom":{ + "name":"CreateRoom", + "http":{ + "method":"POST", + "requestUri":"/CreateRoom", + "responseCode":200 + }, + "input":{"shape":"CreateRoomRequest"}, + "output":{"shape":"CreateRoomResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"PendingVerification"}, + {"shape":"ValidationException"} + ] + }, + "DeleteMessage":{ + "name":"DeleteMessage", + "http":{ + "method":"POST", + "requestUri":"/DeleteMessage", + "responseCode":200 + }, + "input":{"shape":"DeleteMessageRequest"}, + "output":{"shape":"DeleteMessageResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, + "DeleteRoom":{ + "name":"DeleteRoom", + "http":{ + "method":"POST", + "requestUri":"/DeleteRoom", + "responseCode":204 + }, + "input":{"shape":"DeleteRoomRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, + "DisconnectUser":{ + "name":"DisconnectUser", + "http":{ + "method":"POST", + "requestUri":"/DisconnectUser", + "responseCode":200 + }, + "input":{"shape":"DisconnectUserRequest"}, + "output":{"shape":"DisconnectUserResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, + "GetRoom":{ + "name":"GetRoom", + "http":{ + "method":"POST", + "requestUri":"/GetRoom", + "responseCode":200 + }, + "input":{"shape":"GetRoomRequest"}, + "output":{"shape":"GetRoomResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, + "ListRooms":{ + "name":"ListRooms", + "http":{ + "method":"POST", + "requestUri":"/ListRooms", + "responseCode":200 + }, + "input":{"shape":"ListRoomsRequest"}, + "output":{"shape":"ListRoomsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + }, + "SendEvent":{ + "name":"SendEvent", + "http":{ + "method":"POST", + "requestUri":"/SendEvent", + "responseCode":200 + }, + "input":{"shape":"SendEventRequest"}, + "output":{"shape":"SendEventResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "idempotent":true + }, + "UpdateRoom":{ + "name":"UpdateRoom", + "http":{ + "method":"POST", + "requestUri":"/UpdateRoom", + "responseCode":200 + }, + "input":{"shape":"UpdateRoomRequest"}, + "output":{"shape":"UpdateRoomResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ChatToken":{"type":"string"}, + "ChatTokenAttributes":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "ChatTokenCapabilities":{ + "type":"list", + "member":{"shape":"ChatTokenCapability"} + }, + "ChatTokenCapability":{ + "type":"string", + "enum":[ + "SEND_MESSAGE", + "DISCONNECT_USER", + "DELETE_MESSAGE" + ] + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceId":{"shape":"ResourceId"}, + "resourceType":{"shape":"ResourceType"} + }, + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateChatTokenRequest":{ + "type":"structure", + "required":[ + "roomIdentifier", + "userId" + ], + "members":{ + "attributes":{"shape":"ChatTokenAttributes"}, + "capabilities":{"shape":"ChatTokenCapabilities"}, + "roomIdentifier":{"shape":"RoomIdentifier"}, + "sessionDurationInMinutes":{"shape":"SessionDurationInMinutes"}, + "userId":{"shape":"UserID"} + } + }, + "CreateChatTokenResponse":{ + "type":"structure", + "members":{ + "sessionExpirationTime":{"shape":"Time"}, + "token":{"shape":"ChatToken"}, + "tokenExpirationTime":{"shape":"Time"} + } + }, + "CreateRoomRequest":{ + "type":"structure", + "members":{ + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "messageReviewHandler":{"shape":"MessageReviewHandler"}, + "name":{"shape":"RoomName"}, + "tags":{"shape":"Tags"} + } + }, + "CreateRoomResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"RoomArn"}, + "createTime":{"shape":"Time"}, + "id":{"shape":"RoomID"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "messageReviewHandler":{"shape":"MessageReviewHandler"}, + "name":{"shape":"RoomName"}, + "tags":{"shape":"Tags"}, + "updateTime":{"shape":"Time"} + } + }, + "DeleteMessageRequest":{ + "type":"structure", + "required":[ + "id", + "roomIdentifier" + ], + "members":{ + "id":{"shape":"MessageID"}, + "reason":{"shape":"Reason"}, + "roomIdentifier":{"shape":"RoomIdentifier"} + } + }, + "DeleteMessageResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"ID"} + } + }, + "DeleteRoomRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "identifier":{"shape":"RoomIdentifier"} + } + }, + "DisconnectUserRequest":{ + "type":"structure", + "required":[ + "roomIdentifier", + "userId" + ], + "members":{ + "reason":{"shape":"Reason"}, + "roomIdentifier":{"shape":"RoomIdentifier"}, + "userId":{"shape":"UserID"} + } + }, + "DisconnectUserResponse":{ + "type":"structure", + "members":{ + } + }, + "ErrorMessage":{"type":"string"}, + "EventAttributes":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "EventName":{ + "type":"string", + "max":100, + "min":1 + }, + "FallbackResult":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "FieldName":{"type":"string"}, + "GetRoomRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "identifier":{"shape":"RoomIdentifier"} + } + }, + "GetRoomResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"RoomArn"}, + "createTime":{"shape":"Time"}, + "id":{"shape":"RoomID"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "messageReviewHandler":{"shape":"MessageReviewHandler"}, + "name":{"shape":"RoomName"}, + "tags":{"shape":"Tags"}, + "updateTime":{"shape":"Time"} + } + }, + "ID":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^[a-zA-Z0-9]+$" + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LambdaArn":{ + "type":"string", + "max":170, + "min":0, + "pattern":"^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+" + }, + "Limit":{"type":"integer"}, + "ListRoomsRequest":{ + "type":"structure", + "members":{ + "maxResults":{"shape":"MaxRoomResults"}, + "messageReviewHandlerUri":{"shape":"LambdaArn"}, + "name":{"shape":"RoomName"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListRoomsResponse":{ + "type":"structure", + "required":["rooms"], + "members":{ + "nextToken":{"shape":"PaginationToken"}, + "rooms":{"shape":"RoomList"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{"shape":"Tags"} + } + }, + "MaxRoomResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MessageID":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^[a-zA-Z0-9]+$" + }, + "MessageReviewHandler":{ + "type":"structure", + "members":{ + "fallbackResult":{"shape":"FallbackResult"}, + "uri":{"shape":"LambdaArn"} + } + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "min":0 + }, + "PendingVerification":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Reason":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" + }, + "ResourceId":{ + "type":"string", + "pattern":"^[a-zA-Z0-9]+$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceId":{"shape":"ResourceId"}, + "resourceType":{"shape":"ResourceType"} + }, + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":["ROOM"] + }, + "RoomArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$" + }, + "RoomID":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^[a-zA-Z0-9]+$" + }, + "RoomIdentifier":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$" + }, + "RoomList":{ + "type":"list", + "member":{"shape":"RoomSummary"} + }, + "RoomMaxMessageLength":{ + "type":"integer", + "max":500, + "min":1 + }, + "RoomMaxMessageRatePerSecond":{ + "type":"integer", + "max":10, + "min":1 + }, + "RoomName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^[a-zA-Z0-9-_]*$" + }, + "RoomSummary":{ + "type":"structure", + "members":{ + "arn":{"shape":"RoomArn"}, + "createTime":{"shape":"Time"}, + "id":{"shape":"RoomID"}, + "messageReviewHandler":{"shape":"MessageReviewHandler"}, + "name":{"shape":"RoomName"}, + "tags":{"shape":"Tags"}, + "updateTime":{"shape":"Time"} + } + }, + "SendEventRequest":{ + "type":"structure", + "required":[ + "eventName", + "roomIdentifier" + ], + "members":{ + "attributes":{"shape":"EventAttributes"}, + "eventName":{"shape":"EventName"}, + "roomIdentifier":{"shape":"RoomIdentifier"} + } + }, + "SendEventResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"ID"} + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "limit", + "message", + "resourceId", + "resourceType" + ], + "members":{ + "limit":{"shape":"Limit"}, + "message":{"shape":"ErrorMessage"}, + "resourceId":{"shape":"ResourceId"}, + "resourceType":{"shape":"ResourceType"} + }, + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SessionDurationInMinutes":{ + "type":"integer", + "max":180, + "min":1 + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{"shape":"Tags"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "required":[ + "limit", + "message", + "resourceId", + "resourceType" + ], + "members":{ + "limit":{"shape":"Limit"}, + "message":{"shape":"ErrorMessage"}, + "resourceId":{"shape":"ResourceId"}, + "resourceType":{"shape":"ResourceType"} + }, + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateRoomRequest":{ + "type":"structure", + "required":["identifier"], + "members":{ + "identifier":{"shape":"RoomIdentifier"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "messageReviewHandler":{"shape":"MessageReviewHandler"}, + "name":{"shape":"RoomName"} + } + }, + "UpdateRoomResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"RoomArn"}, + "createTime":{"shape":"Time"}, + "id":{"shape":"RoomID"}, + "maximumMessageLength":{"shape":"RoomMaxMessageLength"}, + "maximumMessageRatePerSecond":{"shape":"RoomMaxMessageRatePerSecond"}, + "messageReviewHandler":{"shape":"MessageReviewHandler"}, + "name":{"shape":"RoomName"}, + "tags":{"shape":"Tags"}, + "updateTime":{"shape":"Time"} + } + }, + "UserID":{ + "type":"string", + "max":128, + "min":1 + }, + "ValidationException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "fieldList":{"shape":"ValidationExceptionFieldList"}, + "message":{"shape":"ErrorMessage"}, + "reason":{"shape":"ValidationExceptionReason"} + }, + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "message", + "name" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "name":{"shape":"FieldName"} + } + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UNKNOWN_OPERATION", + "FIELD_VALIDATION_FAILED", + "OTHER" + ] + } + } +} diff --git a/models/apis/ivschat/2020-07-14/docs-2.json b/models/apis/ivschat/2020-07-14/docs-2.json new file mode 100644 index 00000000000..f0e693bf1b1 --- /dev/null +++ b/models/apis/ivschat/2020-07-14/docs-2.json @@ -0,0 +1,481 @@ +{ + "version": "2.0", + "service": "Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
Notes on terminology:
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
<p> <b>Resources</b> </p> <p>The following resource is part of Amazon IVS Chat:</p> <ul> <li> <p> <b>Room</b> — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.</p> </li> </ul> <p> <b>API Access Security</b> </p> <p>Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:</p> <ul> <li> <p> <i>Authentication</i> is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.</p> </li> <li> <p> <i>Authorization</i> is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.</p> </li> </ul> <p>Users (viewers) connect to a room using secure access tokens that you create using the <a>CreateChatToken</a> endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.</p> <p> <b>Signing API Requests</b> </p> <p>HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.</p> <p>You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the <code>ivschat:DeleteMessage</code> permission.</p> <p>For more information:</p> <ul> <li> <p>Authentication and generating signatures — See <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> <li> <p>Managing Amazon IVS permissions — See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html">Identity and Access Management</a> on the Security page of the <i>Amazon IVS User Guide</i>.</p> </li> </ul> <p> <b>Messaging Endpoints</b> </p> <ul> <li> <p> <a>DeleteMessage</a> — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s <code>EventName</code> is <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html"> DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p> </li> <li> <p> <a>DisconnectUser</a> — Disconnects all connections using a specified user ID from a room. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html"> DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p> </li> <li> <p> <a>SendEvent</a> — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.</p> </li> </ul> <p> <b>Chat Token Endpoint</b> </p> <ul> <li> <p> <a>CreateChatToken</a> — Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.</p> </li> </ul> <p> <b>Room Endpoints</b> </p> <ul> <li> <p> <a>CreateRoom</a> — Creates a room that allows clients to connect and pass messages.</p> </li> <li> <p> <a>DeleteRoom</a> — Deletes the specified room.</p> </li> <li> <p> <a>GetRoom</a> — Gets the specified room.</p> </li> <li> <p> <a>ListRooms</a> — Gets summary information about all your rooms in the AWS region where the API request is processed. </p> </li> <li> <p> <a>UpdateRoom</a> — Updates a room’s configuration.</p> </li> </ul> <p> <b>Tags Endpoints</b> </p> <ul> <li> <p> <a>ListTagsForResource</a> — Gets information about AWS tags for the specified ARN.</p> </li> <li> <p> <a>TagResource</a> — Adds or updates tags for the AWS resource with the specified ARN.</p> </li> <li> <p> <a>UntagResource</a> — Removes tags from the resource with the specified ARN.</p> </li> </ul> <p>All the above are HTTP operations. There is a separate <i>messaging</i> API for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API Reference</a>.</p> Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
", + "CreateRoom": "Creates a room that allows clients to connect and pass messages.
", + "DeleteMessage": "Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
Deletes the specified room.
", + "DisconnectUser": "Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
", + "GetRoom": "Gets the specified room.
", + "ListRooms": "Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.
Gets information about AWS tags for the specified ARN.
", + "SendEvent": "Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
", + "TagResource": "Adds or updates tags for the AWS resource with the specified ARN.
", + "UntagResource": "Removes tags from the resource with the specified ARN.
", + "UpdateRoom": "Updates a room’s configuration.
" + }, + "shapes": { + "AccessDeniedException": { + "base": "", + "refs": { + } + }, + "ChatToken": { + "base": null, + "refs": { + "CreateChatTokenResponse$token": "The issued client token, encrypted.
" + } + }, + "ChatTokenAttributes": { + "base": null, + "refs": { + "CreateChatTokenRequest$attributes": "Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
" + } + }, + "ChatTokenCapabilities": { + "base": null, + "refs": { + "CreateChatTokenRequest$capabilities": "Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).
" + } + }, + "ChatTokenCapability": { + "base": null, + "refs": { + "ChatTokenCapabilities$member": null + } + }, + "ConflictException": { + "base": "", + "refs": { + } + }, + "CreateChatTokenRequest": { + "base": null, + "refs": { + } + }, + "CreateChatTokenResponse": { + "base": null, + "refs": { + } + }, + "CreateRoomRequest": { + "base": null, + "refs": { + } + }, + "CreateRoomResponse": { + "base": null, + "refs": { + } + }, + "DeleteMessageRequest": { + "base": null, + "refs": { + } + }, + "DeleteMessageResponse": { + "base": null, + "refs": { + } + }, + "DeleteRoomRequest": { + "base": null, + "refs": { + } + }, + "DisconnectUserRequest": { + "base": null, + "refs": { + } + }, + "DisconnectUserResponse": { + "base": null, + "refs": { + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "AccessDeniedException$message": null, + "ConflictException$message": null, + "InternalServerException$message": null, + "PendingVerification$message": null, + "ResourceNotFoundException$message": null, + "ServiceQuotaExceededException$message": null, + "ThrottlingException$message": null, + "ValidationException$message": null, + "ValidationExceptionField$message": "Explanation of the reason for the validation error.
" + } + }, + "EventAttributes": { + "base": null, + "refs": { + "SendEventRequest$attributes": "Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.
" + } + }, + "EventName": { + "base": null, + "refs": { + "SendEventRequest$eventName": "Application-defined name of the event to send to clients.
" + } + }, + "FallbackResult": { + "base": null, + "refs": { + "MessageReviewHandler$fallbackResult": "Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error or times out. If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.
Name of the field which failed validation.
" + } + }, + "GetRoomRequest": { + "base": null, + "refs": { + } + }, + "GetRoomResponse": { + "base": null, + "refs": { + } + }, + "ID": { + "base": null, + "refs": { + "DeleteMessageResponse$id": "Operation identifier, generated by Amazon IVS Chat.
", + "SendEventResponse$id": "An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.
" + } + }, + "InternalServerException": { + "base": "", + "refs": { + } + }, + "LambdaArn": { + "base": null, + "refs": { + "ListRoomsRequest$messageReviewHandlerUri": "Filters the list to match the specified message review handler URI.
", + "MessageReviewHandler$uri": "Identifier of the message review handler. Currently this must be an ARN of a lambda function.
" + } + }, + "Limit": { + "base": null, + "refs": { + "ServiceQuotaExceededException$limit": "", + "ThrottlingException$limit": "" + } + }, + "ListRoomsRequest": { + "base": null, + "refs": { + } + }, + "ListRoomsResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "MaxRoomResults": { + "base": null, + "refs": { + "ListRoomsRequest$maxResults": "Maximum number of rooms to return. Default: 50.
" + } + }, + "MessageID": { + "base": null, + "refs": { + "DeleteMessageRequest$id": "ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).
Configuration information for optional message review.
", + "refs": { + "CreateRoomRequest$messageReviewHandler": "Configuration information for optional review of messages.
", + "CreateRoomResponse$messageReviewHandler": "Configuration information for optional review of messages.
", + "GetRoomResponse$messageReviewHandler": "Configuration information for optional review of messages.
", + "RoomSummary$messageReviewHandler": "Configuration information for optional review of messages.
", + "UpdateRoomRequest$messageReviewHandler": "Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.
Configuration information for optional review of messages.
" + } + }, + "PaginationToken": { + "base": null, + "refs": { + "ListRoomsRequest$nextToken": "The first room to retrieve. This is used for pagination; see the nextToken response field.
If there are more rooms than maxResults, use nextToken in the request to get the next set.
Reason for deleting the message.
", + "DisconnectUserRequest$reason": "Reason for disconnecting the user.
" + } + }, + "ResourceArn": { + "base": null, + "refs": { + "ListTagsForResourceRequest$resourceArn": "The ARN of the resource to be retrieved. The ARN must be URL-encoded.
", + "TagResourceRequest$resourceArn": "The ARN of the resource to be tagged. The ARN must be URL-encoded.
", + "UntagResourceRequest$resourceArn": "The ARN of the resource to be untagged. The ARN must be URL-encoded.
" + } + }, + "ResourceId": { + "base": null, + "refs": { + "ConflictException$resourceId": "", + "ResourceNotFoundException$resourceId": "", + "ServiceQuotaExceededException$resourceId": "", + "ThrottlingException$resourceId": "" + } + }, + "ResourceNotFoundException": { + "base": "", + "refs": { + } + }, + "ResourceType": { + "base": null, + "refs": { + "ConflictException$resourceType": "", + "ResourceNotFoundException$resourceType": "", + "ServiceQuotaExceededException$resourceType": "", + "ThrottlingException$resourceType": "" + } + }, + "RoomArn": { + "base": null, + "refs": { + "CreateRoomResponse$arn": "Room ARN, assigned by the system.
", + "GetRoomResponse$arn": "Room ARN, from the request (if identifier was an ARN).
Room ARN.
", + "UpdateRoomResponse$arn": "Room ARN, from the request (if identifier was an ARN).
Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
", + "GetRoomResponse$id": "Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
", + "RoomSummary$id": "Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
", + "UpdateRoomResponse$id": "Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
" + } + }, + "RoomIdentifier": { + "base": null, + "refs": { + "CreateChatTokenRequest$roomIdentifier": "Identifier of the room that the client is trying to access. Currently this must be an ARN.
", + "DeleteMessageRequest$roomIdentifier": "Identifier of the room where the message should be deleted. Currently this must be an ARN.
", + "DeleteRoomRequest$identifier": "Identifier of the room to be deleted. Currently this must be an ARN.
", + "DisconnectUserRequest$roomIdentifier": "Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.
", + "GetRoomRequest$identifier": "Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.
", + "SendEventRequest$roomIdentifier": "Identifier of the room to which the event will be sent. Currently this must be an ARN.
", + "UpdateRoomRequest$identifier": "Identifier of the room to be updated. Currently this must be an ARN.
" + } + }, + "RoomList": { + "base": null, + "refs": { + "ListRoomsResponse$rooms": "List of the matching rooms (summary information only).
" + } + }, + "RoomMaxMessageLength": { + "base": null, + "refs": { + "CreateRoomRequest$maximumMessageLength": "Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
", + "CreateRoomResponse$maximumMessageLength": "Maximum number of characters in a single message, from the request.
", + "GetRoomResponse$maximumMessageLength": "Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
", + "UpdateRoomRequest$maximumMessageLength": "The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.
", + "UpdateRoomResponse$maximumMessageLength": "Maximum number of characters in a single message, from the request.
" + } + }, + "RoomMaxMessageRatePerSecond": { + "base": null, + "refs": { + "CreateRoomRequest$maximumMessageRatePerSecond": "Maximum number of messages per second that a client can send to the room. Default: 10.
", + "CreateRoomResponse$maximumMessageRatePerSecond": "Maximum number of messages per second that a client can send to the room, from the request.
", + "GetRoomResponse$maximumMessageRatePerSecond": "Maximum number of messages per second that a client can send to the room. Default: 10.
", + "UpdateRoomRequest$maximumMessageRatePerSecond": "The maximum number of messages per second that a client can send to the room. Default: 10.
", + "UpdateRoomResponse$maximumMessageRatePerSecond": "Maximum number of messages per second that a client can send to the room, from the request.
" + } + }, + "RoomName": { + "base": null, + "refs": { + "CreateRoomRequest$name": "Room name. The value does not need to be unique.
", + "CreateRoomResponse$name": "Room name, from the request (if specified).
", + "GetRoomResponse$name": "Room name. The value does not need to be unique.
", + "ListRoomsRequest$name": "Filters the list to match the specified room name.
", + "RoomSummary$name": "Room name. The value does not need to be unique.
", + "UpdateRoomRequest$name": "Room name. The value does not need to be unique.
", + "UpdateRoomResponse$name": "Room name, from the request.
" + } + }, + "RoomSummary": { + "base": "Summary information about a room.
", + "refs": { + "RoomList$member": null + } + }, + "SendEventRequest": { + "base": null, + "refs": { + } + }, + "SendEventResponse": { + "base": null, + "refs": { + } + }, + "ServiceQuotaExceededException": { + "base": "", + "refs": { + } + }, + "SessionDurationInMinutes": { + "base": null, + "refs": { + "CreateChatTokenRequest$sessionDurationInMinutes": "Session duration (in minutes), after which the session expires. Default: 60 (1 hour).
" + } + }, + "String": { + "base": null, + "refs": { + "ChatTokenAttributes$key": null, + "ChatTokenAttributes$value": null, + "EventAttributes$key": null, + "EventAttributes$value": null + } + }, + "TagKey": { + "base": null, + "refs": { + "TagKeyList$member": null, + "Tags$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$tagKeys": "Array of tags to be removed.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tags$value": null + } + }, + "Tags": { + "base": null, + "refs": { + "CreateRoomRequest$tags": "Tags to attach to the resource. Array of maps, each of the form string:string (key:value).
Tags attached to the resource, from the request.
", + "GetRoomResponse$tags": "Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Tags to attach to the resource. Array of maps, each of the form string:string (key:value).
Tags attached to the resource.
", + "TagResourceRequest$tags": "Array of tags to be added or updated.
", + "UpdateRoomResponse$tags": "Tags attached to the resource.
" + } + }, + "ThrottlingException": { + "base": "", + "refs": { + } + }, + "Time": { + "base": null, + "refs": { + "CreateChatTokenResponse$sessionExpirationTime": "Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "CreateChatTokenResponse$tokenExpirationTime": "Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "CreateRoomResponse$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "CreateRoomResponse$updateTime": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "GetRoomResponse$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "GetRoomResponse$updateTime": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "RoomSummary$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "RoomSummary$updateTime": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "UpdateRoomResponse$createTime": "Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
", + "UpdateRoomResponse$updateTime": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
" + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdateRoomRequest": { + "base": null, + "refs": { + } + }, + "UpdateRoomResponse": { + "base": null, + "refs": { + } + }, + "UserID": { + "base": null, + "refs": { + "CreateChatTokenRequest$userId": "Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.
", + "DisconnectUserRequest$userId": "ID of the user (connection) to disconnect from the room.
" + } + }, + "ValidationException": { + "base": "", + "refs": { + } + }, + "ValidationExceptionField": { + "base": "This object is used in the ValidationException error.
", + "refs": { + "ValidationExceptionFieldList$member": null + } + }, + "ValidationExceptionFieldList": { + "base": null, + "refs": { + "ValidationException$fieldList": "" + } + }, + "ValidationExceptionReason": { + "base": null, + "refs": { + "ValidationException$reason": "" + } + } + } +} diff --git a/models/apis/ivschat/2020-07-14/examples-1.json b/models/apis/ivschat/2020-07-14/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/ivschat/2020-07-14/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/ivschat/2020-07-14/paginators-1.json b/models/apis/ivschat/2020-07-14/paginators-1.json new file mode 100644 index 00000000000..427079f1823 --- /dev/null +++ b/models/apis/ivschat/2020-07-14/paginators-1.json @@ -0,0 +1,9 @@ +{ + "pagination": { + "ListRooms": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/models/apis/lightsail/2016-11-28/api-2.json b/models/apis/lightsail/2016-11-28/api-2.json index b7b26007209..cd85acacf04 100644 --- a/models/apis/lightsail/2016-11-28/api-2.json +++ b/models/apis/lightsail/2016-11-28/api-2.json @@ -1799,6 +1799,22 @@ {"shape":"UnauthenticatedException"} ] }, + "GetLoadBalancerTlsPolicies":{ + "name":"GetLoadBalancerTlsPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoadBalancerTlsPoliciesRequest"}, + "output":{"shape":"GetLoadBalancerTlsPoliciesResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"}, + {"shape":"InvalidInputException"} + ] + }, "GetLoadBalancers":{ "name":"GetLoadBalancers", "http":{ @@ -3953,7 +3969,8 @@ "certificateDomainName":{"shape":"DomainName"}, "certificateAlternativeNames":{"shape":"DomainNameList"}, "tags":{"shape":"TagList"}, - "ipAddressType":{"shape":"IpAddressType"} + "ipAddressType":{"shape":"IpAddressType"}, + "tlsPolicyName":{"shape":"string"} } }, "CreateLoadBalancerResult":{ @@ -5365,6 +5382,19 @@ "tlsCertificates":{"shape":"LoadBalancerTlsCertificateList"} } }, + "GetLoadBalancerTlsPoliciesRequest":{ + "type":"structure", + "members":{ + "pageToken":{"shape":"string"} + } + }, + "GetLoadBalancerTlsPoliciesResult":{ + "type":"structure", + "members":{ + "tlsPolicies":{"shape":"LoadBalancerTlsPolicyList"}, + "nextPageToken":{"shape":"string"} + } + }, "GetLoadBalancersRequest":{ "type":"structure", "members":{ @@ -6068,7 +6098,9 @@ "instanceHealthSummary":{"shape":"InstanceHealthSummaryList"}, "tlsCertificateSummaries":{"shape":"LoadBalancerTlsCertificateSummaryList"}, "configurationOptions":{"shape":"LoadBalancerConfigurationOptions"}, - "ipAddressType":{"shape":"IpAddressType"} + "ipAddressType":{"shape":"IpAddressType"}, + "httpsRedirectionEnabled":{"shape":"boolean"}, + "tlsPolicyName":{"shape":"ResourceName"} } }, "LoadBalancerAttributeName":{ @@ -6076,7 +6108,9 @@ "enum":[ "HealthCheckPath", "SessionStickinessEnabled", - "SessionStickiness_LB_CookieDurationSeconds" + "SessionStickiness_LB_CookieDurationSeconds", + "HttpsRedirectionEnabled", + "TlsPolicyName" ] }, "LoadBalancerConfigurationOptions":{ @@ -6254,6 +6288,20 @@ "type":"list", "member":{"shape":"LoadBalancerTlsCertificateSummary"} }, + "LoadBalancerTlsPolicy":{ + "type":"structure", + "members":{ + "name":{"shape":"ResourceName"}, + "isDefault":{"shape":"boolean"}, + "description":{"shape":"string"}, + "protocols":{"shape":"StringList"}, + "ciphers":{"shape":"StringList"} + } + }, + "LoadBalancerTlsPolicyList":{ + "type":"list", + "member":{"shape":"LoadBalancerTlsPolicy"} + }, "LogEvent":{ "type":"structure", "members":{ diff --git a/models/apis/lightsail/2016-11-28/docs-2.json b/models/apis/lightsail/2016-11-28/docs-2.json index 3801498d091..d1a5bb7d7df 100644 --- a/models/apis/lightsail/2016-11-28/docs-2.json +++ b/models/apis/lightsail/2016-11-28/docs-2.json @@ -1,20 +1,20 @@ { "version": "2.0", - "service": "Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported AWS Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the AWS General Reference.
", + "service": "Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
", "operations": { "AllocateStaticIp": "Allocates a static IP address.
", - "AttachCertificateToDistribution": "Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the CreateCertificate action to create a certificate that you can attach to your distribution.
Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the CreateCertificate action to create a certificate that you can attach to your distribution.
Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide.
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate.
The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.
Attaches a static IP address to a specific Amazon Lightsail instance.
", "CloseInstancePublicPorts": "Closes ports for a specific Amazon Lightsail instance.
The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.
When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.
When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.
Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
", "CreateBucketAccessKey": "Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.
Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.
Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.
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 AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
", + "CreateContactMethod": "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.
", "CreateContainerService": "Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
", "CreateContainerServiceDeployment": "Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
", "CreateContainerServiceRegistryLogin": "Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
Deletes an alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
", "DeleteAutoSnapshot": "Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
", - "DeleteBucket": "Deletes a Amazon Lightsail bucket.
When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another AWS account.
Deletes a Amazon Lightsail bucket.
When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.
Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
", "DeleteCertificate": "Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.
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 AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
", + "DeleteContactMethod": "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.
", "DeleteContainerImage": "Deletes a container image that is registered to your Amazon Lightsail container service.
", "DeleteContainerService": "Deletes your Amazon Lightsail container service.
", "DeleteDisk": "Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).
The disk may remain in the deleting state for several minutes.
The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
", "GetCertificates": "Returns information about one or more Amazon Lightsail SSL/TLS certificates.
To get a summary of a certificate, ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.
An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
", - "GetContactMethods": "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 AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
", + "GetContactMethods": "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.
", "GetContainerAPIMetadata": "Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
", "GetContainerImages": "Returns the container images that are registered to your Amazon Lightsail container service.
If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.
Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference.
Returns information about the specified Lightsail load balancer.
", "GetLoadBalancerMetricData": "Returns information about health metrics for your Lightsail load balancer.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
", "GetLoadBalancerTlsCertificates": "Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
", + "GetLoadBalancerTlsPolicies": "Returns a list of TLS security policies that you can apply to Lightsail load balancers.
For more information about load balancer TLS security policies, see Load balancer TLS security policies in the Amazon Lightsail Developer Guide.
", "GetLoadBalancers": "Returns information about all load balancers in an account.
", "GetOperation": "Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
", "GetOperations": "Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.
Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
Deletes a specific static IP from your account.
", "ResetDistributionCache": "Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
", - "SendContactMethodVerification": "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 AWS Region. However, SMS text messaging is not supported in some AWS 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.
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.
Sets the IP address type for an Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
", - "SetResourceAccessForBucket": "Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same AWS Region.
", + "SetResourceAccessForBucket": "Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
", "StartInstance": "Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.
The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.
Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
", "UnpeerVpc": "Unpeers the Lightsail VPC from the user's default VPC.
", "UntagResource": "Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide.
Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the AWS accounts that can access the bucket.
", + "UpdateBucket": "Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.
", "UpdateBucketBundle": "Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
", "UpdateContainerService": "Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
", "UpdateDistribution": "Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
", @@ -492,14 +493,14 @@ "base": null, "refs": { "Bucket$name": "The name of the bucket.
", - "BucketAccessLogConfig$destination": "The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same AWS Region as the source bucket.
This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.
The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.
This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.
The name of the bucket that the new access key will belong to, and grant access to.
", "CreateBucketRequest$bucketName": "The name for the bucket.
For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.
", "DeleteBucketAccessKeyRequest$bucketName": "The name of the bucket that the access key belongs to.
", "DeleteBucketRequest$bucketName": "The name of the bucket to delete.
Use the GetBuckets action to get a list of bucket names that you can specify.
", "GetBucketAccessKeysRequest$bucketName": "The name of the bucket for which to return access keys.
", "GetBucketMetricDataRequest$bucketName": "The name of the bucket for which to get metric data.
", - "GetBucketsRequest$bucketName": "The name of the bucket for which to return information.
When omitted, the response includes all of your buckets in the AWS Region where the request is made.
", + "GetBucketsRequest$bucketName": "The name of the bucket for which to return information.
When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.
", "SetResourceAccessForBucketRequest$bucketName": "The name of the bucket for which to set access to another Lightsail resource.
", "UpdateBucketBundleRequest$bucketName": "The name of the bucket for which to update the bundle.
", "UpdateBucketRequest$bucketName": "The name of the bucket to update.
" @@ -566,7 +567,7 @@ "CertificateSummary$certificateName": "The name of the certificate.
", "CreateCertificateRequest$certificateName": "The name for the certificate.
", "DeleteCertificateRequest$certificateName": "The name of the certificate to delete.
Use the GetCertificates action to get a list of certificate names that you can specify.
The name for the certificate for which to return information.
When omitted, the response includes all of your certificates in the AWS Region where the request is made.
" + "GetCertificatesRequest$certificateName": "The name for the certificate for which to return information.
When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.
" } }, "CertificateStatus": { @@ -579,7 +580,7 @@ "CertificateStatusList": { "base": null, "refs": { - "GetCertificatesRequest$certificateStatuses": "The status of the certificates for which to return information.
For example, specify ISSUED to return only certificates with an ISSUED status.
When omitted, the response includes all of your certificates in the AWS Region where the request is made, regardless of their current status.
" + "GetCertificatesRequest$certificateStatuses": "The status of the certificates for which to return information.
For example, specify ISSUED to return only certificates with an ISSUED status.
When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.
" } }, "CertificateSummary": { @@ -671,7 +672,7 @@ "refs": { "ContactMethod$protocol": "The protocol of the contact method, such as email or SMS (text messaging).
", "ContactProtocolsList$member": null, - "CreateContactMethodRequest$protocol": "The protocol of the contact method, such as Email or SMS (text messaging).
The SMS protocol is supported only in the following AWS 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 AWS 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.
", + "CreateContactMethodRequest$protocol": "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.
", "DeleteContactMethodRequest$protocol": "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.
The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
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.
", - "PutAlarmRequest$contactProtocols": "The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.
A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.
Use the CreateContactMethod action to configure a contact protocol in an AWS Region.
The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.
A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the Amazon Web Services Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.
Use the CreateContactMethod action to configure a contact protocol in an Amazon Web Services Region.
Describes a container image that is registered to an Amazon Lightsail container service.
", "refs": { "ContainerImageList$member": null, - "RegisterContainerImageResult$containerImage": null + "RegisterContainerImageResult$containerImage": "An object that describes a container image that is registered to a Lightsail container service
" } }, "ContainerImageList": { @@ -812,14 +813,14 @@ "refs": { "ContainerService$containerServiceName": "The name of the container service.
", "CreateContainerServiceDeploymentRequest$serviceName": "The name of the container service for which to create the deployment.
", - "CreateContainerServiceRequest$serviceName": "The name for the container service.
The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) AWS region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com
The following are the requirements for container service names:
Must be unique within each AWS Region in your Lightsail account.
Must contain 1 to 63 characters.
Must contain only alphanumeric characters and hyphens.
A hyphen (-) can separate words but cannot be at the start or end of the name.
The name for the container service.
The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) AWS region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com
The following are the requirements for container service names:
Must be unique within each Amazon Web Services Region in your Lightsail account.
Must contain 1 to 63 characters.
Must contain only alphanumeric characters and hyphens.
A hyphen (-) can separate words but cannot be at the start or end of the name.
The name of the container service for which to delete a registered container image.
", "DeleteContainerServiceRequest$serviceName": "The name of the container service to delete.
", "GetContainerImagesRequest$serviceName": "The name of the container service for which to return registered container images.
", "GetContainerLogRequest$serviceName": "The name of the container service for which to get a container log.
", "GetContainerServiceDeploymentsRequest$serviceName": "The name of the container service for which to return deployments.
", "GetContainerServiceMetricDataRequest$serviceName": "The name of the container service for which to get metric data.
", - "GetContainerServicesRequest$serviceName": "The name of the container service for which to return information.
When omitted, the response includes all of your container services in the AWS Region where the request is made.
", + "GetContainerServicesRequest$serviceName": "The name of the container service for which to return information.
When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.
", "RegisterContainerImageRequest$serviceName": "The name of the container service for which to register a container image.
", "UpdateContainerServiceRequest$serviceName": "The name of the container service to update.
" } @@ -2103,6 +2104,16 @@ "refs": { } }, + "GetLoadBalancerTlsPoliciesRequest": { + "base": null, + "refs": { + } + }, + "GetLoadBalancerTlsPoliciesResult": { + "base": null, + "refs": { + } + }, "GetLoadBalancersRequest": { "base": null, "refs": { @@ -2509,7 +2520,7 @@ } }, "InvalidInputException": { - "base": "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) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
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.
The name of the attribute you want to update. Valid values are below.
" + "UpdateLoadBalancerAttributeRequest$attributeName": "The name of the attribute you want to update.
" } }, "LoadBalancerConfigurationOptions": { @@ -2787,6 +2798,18 @@ "LoadBalancer$tlsCertificateSummaries": "An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.
Describes the TLS security policies that are available for Lightsail load balancers.
For more information about load balancer TLS security policies, see Load balancer TLS security policies in the Amazon Lightsail Developer Guide.
", + "refs": { + "LoadBalancerTlsPolicyList$member": null + } + }, + "LoadBalancerTlsPolicyList": { + "base": null, + "refs": { + "GetLoadBalancerTlsPoliciesResult$tlsPolicies": "An array of objects that describe the TLS security policies that are available.
" + } + }, "LogEvent": { "base": "Describes a database log event.
", "refs": { @@ -3034,7 +3057,7 @@ "PutInstancePublicPortsResult$operation": "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.
", "ResetDistributionCacheResult$operation": "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.
", "UnpeerVpcResult$operation": "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.
", - "UpdateDistributionBundleResult$operation": null, + "UpdateDistributionBundleResult$operation": "An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
", "UpdateDistributionResult$operation": "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.
" } }, @@ -3141,8 +3164,8 @@ "PartnerIdList": { "base": null, "refs": { - "Bucket$readonlyAccessAccounts": "An array of strings that specify the AWS account IDs that have read-only access to the bucket.
", - "UpdateBucketRequest$readonlyAccessAccounts": "An array of strings to specify the AWS account IDs that can access the bucket.
You can give a maximum of 10 AWS accounts access to a bucket.
" + "Bucket$readonlyAccessAccounts": "An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.
", + "UpdateBucketRequest$readonlyAccessAccounts": "An array of strings to specify the Amazon Web Services account IDs that can access the bucket.
You can give a maximum of 10 Amazon Web Services accounts access to a bucket.
" } }, "PasswordData": { @@ -3304,7 +3327,7 @@ "RegionName": { "base": null, "refs": { - "CopySnapshotRequest$sourceRegion": "The AWS Region where the source manual or automatic snapshot is located.
", + "CopySnapshotRequest$sourceRegion": "The Amazon Web Services Region where the source manual or automatic snapshot is located.
", "InputOrigin$regionName": "The AWS Region name of the origin resource.
", "Origin$regionName": "The AWS Region name of the origin resource.
", "Region$name": "The region name (e.g., us-east-2).
Describes the resource location.
", "refs": { "Alarm$location": "An object that lists information about the location of the alarm.
", - "Bucket$location": null, - "CloudFormationStackRecord$location": "A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
", - "ContactMethod$location": null, - "ContainerService$location": "An object that describes the location of the container service, such as the AWS Region and Availability Zone.
", + "Bucket$location": "An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.
", + "CloudFormationStackRecord$location": "A list of objects describing the Availability Zone and Amazon Web Services Region of the CloudFormation stack record.
", + "ContactMethod$location": "An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.
", + "ContainerService$location": "An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.
", "Disk$location": "The AWS Region and Availability Zone where the disk is located.
", "DiskSnapshot$location": "The AWS Region and Availability Zone where the disk snapshot was created.
", "Domain$location": "The AWS Region and Availability Zones where the domain recordset was created.
", @@ -3500,10 +3523,10 @@ "Instance$location": "The region name and Availability Zone where the instance is located.
", "InstanceSnapshot$location": "The region name and Availability Zone where you created the snapshot.
", "KeyPair$location": "The region name and Availability Zone where the key pair was created.
", - "LightsailDistribution$location": "An object that describes the location of the distribution, such as the AWS Region and Availability Zone.
Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.
Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.
The AWS Region and Availability Zone where you created your certificate.
", - "Operation$location": "The AWS Region and Availability Zone.
", + "Operation$location": "The Amazon Web Services Region and Availability Zone.
", "RelationalDatabase$location": "The Region name and Availability Zone where the database is located.
", "RelationalDatabaseSnapshot$location": "The Region name and Availability Zone where the database snapshot is located.
", "StaticIp$location": "The region and Availability Zone where the static IP was created.
" @@ -3592,7 +3615,7 @@ "GetDiskSnapshotRequest$diskSnapshotName": "The name of the disk snapshot (e.g., my-disk-snapshot).
The name of the distribution for which to return the timestamp of the last cache reset.
Use the GetDistributions action to get a list of distribution names that you can specify.
When omitted, the response includes the latest cache reset timestamp of all your distributions.
", "GetDistributionMetricDataRequest$distributionName": "The name of the distribution for which to get metric data.
Use the GetDistributions action to get a list of distribution names that you can specify.
The name of the distribution for which to return information.
When omitted, the response includes all of your distributions in the AWS Region where the request is made.
", + "GetDistributionsRequest$distributionName": "The name of the distribution for which to return information.
When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.
", "GetInstanceAccessDetailsRequest$instanceName": "The name of the instance to access.
", "GetInstanceMetricDataRequest$instanceName": "The name of the instance for which you want to get metrics data.
", "GetInstancePortStatesRequest$instanceName": "The name of the instance for which to return firewall port states.
", @@ -3626,9 +3649,11 @@ "LightsailDistribution$name": "The name of the distribution.
", "LightsailDistribution$certificateName": "The name of the SSL/TLS certificate attached to the distribution, if any.
", "LoadBalancer$name": "The name of the load balancer (e.g., my-load-balancer).
The name of the TLS security policy for the load balancer.
The following TLS security policy names are possible:
TLS-2016-08
TLS-FS-Res-1-2-2019-08
The name of the SSL/TLS certificate (e.g., my-certificate).
The load balancer name where your SSL/TLS certificate is attached.
", "LoadBalancerTlsCertificateSummary$name": "The name of the SSL/TLS certificate.
", + "LoadBalancerTlsPolicy$name": "The name of the TLS security policy.
The following TLS security policy names are possible:
TLS-2016-08
TLS-FS-Res-1-2-2019-08
You can specify either of these values for the tlsSecurityPolicyName request parameter in the CreateLoadBalancer action, and the attributeValue request parameter in the UpdateLoadBalancerAttribute action.
The name of the Lightsail resource being monitored.
", "OpenInstancePublicPortsRequest$instanceName": "The name of the instance for which to open ports.
", "Operation$resourceName": "The resource name.
", @@ -3706,7 +3731,7 @@ "Origin$resourceType": "The resource type of the origin resource (e.g., Instance).
", "RelationalDatabase$resourceType": "The Lightsail resource type for the database (for example, RelationalDatabase).
The Lightsail resource type.
", - "SetIpAddressTypeRequest$resourceType": "The resource type.
The possible values are Distribution, Instance, and LoadBalancer.
Distribution-related APIs are available only in the N. Virginia (us-east-1) AWS Region. Set your AWS Region configuration to us-east-1 to create, view, or edit distributions.
The resource type.
The possible values are Distribution, Instance, and LoadBalancer.
Distribution-related APIs are available only in the N. Virginia (us-east-1) Amazon Web Services Region. Set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit distributions.
The resource type (usually StaticIp).
An alias that defines access for a preconfigured range of IP addresses.
The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
The alternate domain names of the distribution.
", "LoadBalancerTlsCertificate$subjectAlternativeNames": "An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
The protocols used in a given TLS security policy.
The following protocols are possible:
Protocol-TLSv1
Protocol-TLSv1.1
Protocol-TLSv1.2
The ciphers used by the TLS security policy.
The ciphers are listed in order of preference.
", "PortInfo$cidrs": "The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.
Examples:
To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.
To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
", "PortInfo$ipv6Cidrs": "The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
", "PortInfo$cidrListAliases": "An alias that defines access for a preconfigured range of IP addresses.
The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
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.
", - "UpdateLoadBalancerAttributeRequest$attributeValue": "The value that you want to specify for the attribute name.
" + "UpdateLoadBalancerAttributeRequest$attributeValue": "The value that you want to specify for the attribute name.
The following values are supported depending on what you specify for the attributeName request parameter:
If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, /weather/us/wa/seattle).
If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true or false.
If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds.
If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true or false.
If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be TLS version 1.0, 1.1, and 1.2 or TLS version 1.2.
A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
", "Alarm$notificationEnabled": "Indicates whether the alarm is enabled.
", "Blueprint$isActive": "A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
", - "Bucket$ableToUpdateBundle": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.
You can update a bucket's bundle only one time within a monthly AWS billing cycle.
Use the UpdateBucketBundle action to change a bucket's bundle.
", + "Bucket$ableToUpdateBundle": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.
You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.
Use the UpdateBucketBundle action to change a bucket's bundle.
", "BucketAccessLogConfig$enabled": "A Boolean value that indicates whether bucket access logging is enabled for the bucket.
", "BucketBundle$isActive": "Indicates whether the bundle is active. Use for a new or existing bucket.
", "Bundle$isActive": "A Boolean value indicating whether the bundle is active.
", @@ -4119,8 +4146,10 @@ "IsVpcPeeredResult$isPeered": "Returns true if the Lightsail VPC is peered; otherwise, false.
Indicates whether the distribution is enabled.
", "LightsailDistribution$ableToUpdateBundle": "Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
Use the UpdateDistributionBundle action to change your distribution's bundle.
A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.
", "LoadBalancerTlsCertificate$isAttached": "When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
A Boolean value that indicates whether the TLS security policy is the default.
", "Operation$isTerminal": "A Boolean value indicating whether the operation is terminal.
", "PendingModifiedRelationalDatabaseValues$backupRetentionEnabled": "A Boolean value indicating whether automated backup retention is enabled.
", "PutAlarmRequest$notificationEnabled": "Indicates whether the alarm is enabled.
Notifications are enabled by default if you don't specify this parameter.
", @@ -4257,7 +4286,7 @@ "ContainerImage$image": "The name of the container image.
", "ContainerImage$digest": "The digest of the container image.
", "ContainerService$powerId": "The ID of the power of the container service.
", - "ContainerService$principalArn": "The principal ARN of the container service.
The principal ARN can be used to create a trust relationship between your standard AWS account and your Lightsail container service. This allows you to give your service permission to access resources in your standard AWS account.
", + "ContainerService$principalArn": "The principal ARN of the container service.
The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your service permission to access resources in your standard Amazon Web Services account.
", "ContainerService$privateDomainName": "The private domain name of the container service.
The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.
", "ContainerService$url": "The publicly accessible URL of the container service.
If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.
The name of the container entry of the deployment that the endpoint configuration applies to.
", @@ -4286,6 +4315,7 @@ "CreateInstancesRequest$availabilityZone": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.
A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.
The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., \"/\").
You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
", + "CreateLoadBalancerRequest$tlsPolicyName": "The name of the TLS policy to apply to the load balancer.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Load balancer TLS security policies in the Amazon Lightsail Developer Guide.
", "CreateRelationalDatabaseFromSnapshotRequest$availabilityZone": "The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.
The bundle ID for your new database. A bundle describes the performance specifications for your database.
You can get a list of database bundle IDs by using the get relational database bundles operation.
When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.
", "CreateRelationalDatabaseRequest$availabilityZone": "The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetLoadBalancerTlsPolicies request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetLoadBalancerTlsPolicies request and specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetLoadBalancers request and specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetOperationsForResource request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.
", "LoadBalancerConfigurationOptions$value": null, "LoadBalancerTlsCertificate$supportCode": "The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.
", + "LoadBalancerTlsPolicy$description": "The description of the TLS security policy.
", "LogEvent$message": "The message of the database log event.
", "NotFoundException$code": null, "NotFoundException$docs": null, diff --git a/models/apis/network-firewall/2020-11-12/api-2.json b/models/apis/network-firewall/2020-11-12/api-2.json index db90daa5292..419ad104b6a 100644 --- a/models/apis/network-firewall/2020-11-12/api-2.json +++ b/models/apis/network-firewall/2020-11-12/api-2.json @@ -408,6 +408,23 @@ {"shape":"InvalidTokenException"} ] }, + "UpdateFirewallEncryptionConfiguration":{ + "name":"UpdateFirewallEncryptionConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFirewallEncryptionConfigurationRequest"}, + "output":{"shape":"UpdateFirewallEncryptionConfigurationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidTokenException"}, + {"shape":"ResourceOwnerCheckException"} + ] + }, "UpdateFirewallPolicy":{ "name":"UpdateFirewallPolicy", "http":{ @@ -608,7 +625,8 @@ "FirewallPolicy":{"shape":"FirewallPolicy"}, "Description":{"shape":"Description"}, "Tags":{"shape":"TagList"}, - "DryRun":{"shape":"Boolean"} + "DryRun":{"shape":"Boolean"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} } }, "CreateFirewallPolicyResponse":{ @@ -639,7 +657,8 @@ "SubnetChangeProtection":{"shape":"Boolean"}, "FirewallPolicyChangeProtection":{"shape":"Boolean"}, "Description":{"shape":"Description"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} } }, "CreateFirewallResponse":{ @@ -664,7 +683,8 @@ "Description":{"shape":"Description"}, "Capacity":{"shape":"RuleCapacity"}, "Tags":{"shape":"TagList"}, - "DryRun":{"shape":"Boolean"} + "DryRun":{"shape":"Boolean"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} } }, "CreateRuleGroupResponse":{ @@ -901,6 +921,20 @@ "UpdateToken":{"shape":"UpdateToken"} } }, + "EncryptionConfiguration":{ + "type":"structure", + "members":{ + "KeyId":{"shape":"KeyId"}, + "Type":{"shape":"EncryptionType"} + } + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "CUSTOMER_KMS", + "AWS_OWNED_KMS_KEY" + ] + }, "EndpointId":{"type":"string"}, "ErrorMessage":{"type":"string"}, "Firewall":{ @@ -922,7 +956,8 @@ "FirewallPolicyChangeProtection":{"shape":"Boolean"}, "Description":{"shape":"Description"}, "FirewallId":{"shape":"ResourceId"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} } }, "FirewallMetadata":{ @@ -975,7 +1010,8 @@ "Tags":{"shape":"TagList"}, "ConsumedStatelessRuleCapacity":{"shape":"RuleCapacity"}, "ConsumedStatefulRuleCapacity":{"shape":"RuleCapacity"}, - "NumberOfAssociations":{"shape":"NumberOfAssociations"} + "NumberOfAssociations":{"shape":"NumberOfAssociations"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} } }, "FirewallStatus":{ @@ -1100,6 +1136,12 @@ }, "exception":true }, + "KeyId":{ + "type":"string", + "max":2048, + "min":1, + "pattern":".*\\S.*" + }, "Keyword":{ "type":"string", "max":128, @@ -1439,7 +1481,8 @@ "RuleGroupStatus":{"shape":"ResourceStatus"}, "Tags":{"shape":"TagList"}, "ConsumedCapacity":{"shape":"RuleCapacity"}, - "NumberOfAssociations":{"shape":"NumberOfAssociations"} + "NumberOfAssociations":{"shape":"NumberOfAssociations"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} } }, "RuleGroupType":{ @@ -1855,6 +1898,24 @@ "UpdateToken":{"shape":"UpdateToken"} } }, + "UpdateFirewallEncryptionConfigurationRequest":{ + "type":"structure", + "members":{ + "UpdateToken":{"shape":"UpdateToken"}, + "FirewallArn":{"shape":"ResourceArn"}, + "FirewallName":{"shape":"ResourceName"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} + } + }, + "UpdateFirewallEncryptionConfigurationResponse":{ + "type":"structure", + "members":{ + "FirewallArn":{"shape":"ResourceArn"}, + "FirewallName":{"shape":"ResourceName"}, + "UpdateToken":{"shape":"UpdateToken"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} + } + }, "UpdateFirewallPolicyChangeProtectionRequest":{ "type":"structure", "required":["FirewallPolicyChangeProtection"], @@ -1886,7 +1947,8 @@ "FirewallPolicyName":{"shape":"ResourceName"}, "FirewallPolicy":{"shape":"FirewallPolicy"}, "Description":{"shape":"Description"}, - "DryRun":{"shape":"Boolean"} + "DryRun":{"shape":"Boolean"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} } }, "UpdateFirewallPolicyResponse":{ @@ -1927,7 +1989,8 @@ "Rules":{"shape":"RulesString"}, "Type":{"shape":"RuleGroupType"}, "Description":{"shape":"Description"}, - "DryRun":{"shape":"Boolean"} + "DryRun":{"shape":"Boolean"}, + "EncryptionConfiguration":{"shape":"EncryptionConfiguration"} } }, "UpdateRuleGroupResponse":{ diff --git a/models/apis/network-firewall/2020-11-12/docs-2.json b/models/apis/network-firewall/2020-11-12/docs-2.json index 47d0556abcf..5efc7baf443 100644 --- a/models/apis/network-firewall/2020-11-12/docs-2.json +++ b/models/apis/network-firewall/2020-11-12/docs-2.json @@ -1,11 +1,11 @@ { "version": "2.0", - "service": "This is the API Reference for AWS Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.
The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the AWS REST APIs, see AWS APIs.
To access Network Firewall using the REST API endpoint: https://network-firewall.<region>.amazonaws.com
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source intrusion detection system (IDS) engine. AWS Network Firewall supports Suricata version 5.0.2. For information about Suricata, see the Suricata website.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
To start using Network Firewall, do the following:
(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.
In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.
This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.
The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
To access Network Firewall using the REST API endpoint: https://network-firewall.<region>.amazonaws.com
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source intrusion detection system (IDS) engine. Network Firewall supports Suricata version 5.0.2. For information about Suricata, see the Suricata website.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
To start using Network Firewall, do the following:
(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.
In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.
Associates a FirewallPolicy to a Firewall.
A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
", - "AssociateSubnets": "Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.
This request creates an AWS Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.
", - "CreateFirewall": "Creates an AWS Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an AWS Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard AWS resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
", - "CreateFirewallPolicy": "Creates the firewall policy for the firewall according to the specifications.
An AWS Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
", + "AssociateSubnets": "Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.
This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.
", + "CreateFirewall": "Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
", + "CreateFirewallPolicy": "Creates the firewall policy for the firewall according to the specifications.
An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
", "CreateRuleGroup": "Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
You provide your rule group specification in your request using either RuleGroup or Rules.
Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection flag to be FALSE. You can't revert this operation.
You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.
To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.
", "DeleteFirewallPolicy": "Deletes the specified FirewallPolicy.
", @@ -21,12 +21,13 @@ "ListFirewallPolicies": "Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.
", "ListFirewalls": "Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.
Depending on your setting for max results and the number of firewalls, a single call might not return the full list.
", "ListRuleGroups": "Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.
", - "ListTagsForResource": "Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
", - "PutResourcePolicy": "Creates or updates an AWS Identity and Access Management policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the AWS Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.
When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see AWS Resource Access Manager User Guide.
", - "TagResource": "Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
", - "UntagResource": "Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can manage tags for the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
", + "ListTagsForResource": "Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
", + "PutResourcePolicy": "Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.
When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
", + "TagResource": "Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
", + "UntagResource": "Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
", "UpdateFirewallDeleteProtection": "Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use.
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
", + "UpdateFirewallEncryptionConfiguration": "A complex type that contains settings for encryption of your firewall resources.
", "UpdateFirewallPolicy": "Updates the properties of the specified firewall policy.
", "UpdateFirewallPolicyChangeProtection": "Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use.
Sets the logging configuration for the specified firewall.
To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.
You can perform only one of the following actions in any call to UpdateLoggingConfiguration:
Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs.
Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs.
Change the LogDestination setting in a single LogDestinationConfig array element.
You can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these settings, delete the existing LogDestinationConfig object and create a new one, using two separate calls to this update operation.
The configuration and status for a single subnet that you've specified for use by the AWS Network Firewall firewall. This is part of the FirewallStatus.
", + "base": "The configuration and status for a single subnet that you've specified for use by the Network Firewall firewall. This is part of the FirewallStatus.
", "refs": { "SyncState$Attachment": "The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.
" } @@ -318,7 +319,7 @@ } }, "Dimension": { - "base": "The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
AWS Network Firewall sets the dimension name to CustomAction and you provide the dimension value.
For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.
", + "base": "The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
Network Firewall sets the dimension name to CustomAction and you provide the dimension value.
For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.
", "refs": { "Dimensions$member": null } @@ -345,6 +346,27 @@ "refs": { } }, + "EncryptionConfiguration": { + "base": "A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
", + "refs": { + "CreateFirewallPolicyRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your firewall policy resources.
", + "CreateFirewallRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your firewall resources.
", + "CreateRuleGroupRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your rule group resources.
", + "Firewall$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
", + "FirewallPolicyResponse$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
", + "RuleGroupResponse$EncryptionConfiguration": "A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
", + "UpdateFirewallEncryptionConfigurationRequest$EncryptionConfiguration": null, + "UpdateFirewallEncryptionConfigurationResponse$EncryptionConfiguration": null, + "UpdateFirewallPolicyRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your firewall policy resources.
", + "UpdateRuleGroupRequest$EncryptionConfiguration": "A complex type that contains settings for encryption of your rule group resources.
" + } + }, + "EncryptionType": { + "base": null, + "refs": { + "EncryptionConfiguration$Type": "The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
" + } + }, "EndpointId": { "base": null, "refs": { @@ -369,7 +391,7 @@ } }, "Firewall": { - "base": "The firewall defines the configuration settings for an AWS Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.
", + "base": "The firewall defines the configuration settings for an Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.
", "refs": { "CreateFirewallResponse$Firewall": "The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
", "DeleteFirewallResponse$Firewall": null, @@ -457,7 +479,7 @@ } }, "Header": { - "base": "The basic rule criteria for AWS Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding StatefulRule.
", + "base": "The basic rule criteria for Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding StatefulRule.
", "refs": { "StatefulRule$Header": "The stateful inspection criteria for this rule, used to inspect traffic flows.
" } @@ -475,7 +497,7 @@ } }, "InsufficientCapacityException": { - "base": "AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.
", + "base": "Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.
", "refs": { } }, @@ -504,6 +526,12 @@ "refs": { } }, + "KeyId": { + "base": null, + "refs": { + "EncryptionConfiguration$KeyId": "The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
" + } + }, "Keyword": { "base": null, "refs": { @@ -556,7 +584,7 @@ } }, "LogDestinationConfig": { - "base": "Defines where AWS Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
Network Firewall generates logs for stateful rule groups. You can save alert and flow log types. The stateful rules engine records flow logs for all network traffic that it receives. It records alert logs for traffic that matches stateful rules that have the rule action set to DROP or ALERT.
Defines where Network Firewall sends logs for the firewall for one log type. This is used in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
Network Firewall generates logs for stateful rule groups. You can save alert and flow log types. The stateful rules engine records flow logs for all network traffic that it receives. It records alert logs for traffic that matches stateful rules that have the rule action set to DROP or ALERT.
Defines how AWS Network Firewall performs logging for a Firewall.
", + "base": "Defines how Network Firewall performs logging for a Firewall.
", "refs": { "DescribeLoggingConfigurationResponse$LoggingConfiguration": null, "UpdateLoggingConfigurationRequest$LoggingConfiguration": "Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.
", @@ -653,8 +681,8 @@ "PolicyString": { "base": null, "refs": { - "DescribeResourcePolicyResponse$Policy": "The AWS Identity and Access Management policy for the resource.
", - "PutResourcePolicyRequest$Policy": "The AWS Identity and Access Management policy statement that lists the accounts that you want to share your rule group or firewall policy with and the operations that you want the accounts to be able to perform.
For a rule group resource, you can specify the following operations in the Actions section of the statement:
network-firewall:CreateFirewallPolicy
network-firewall:UpdateFirewallPolicy
network-firewall:ListRuleGroups
For a firewall policy resource, you can specify the following operations in the Actions section of the statement:
network-firewall:CreateFirewall
network-firewall:UpdateFirewall
network-firewall:AssociateFirewallPolicy
network-firewall:ListFirewallPolicies
In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in Arn.
The IAM policy for the resource.
", + "PutResourcePolicyRequest$Policy": "The IAM policy statement that lists the accounts that you want to share your rule group or firewall policy with and the operations that you want the accounts to be able to perform.
For a rule group resource, you can specify the following operations in the Actions section of the statement:
network-firewall:CreateFirewallPolicy
network-firewall:UpdateFirewallPolicy
network-firewall:ListRuleGroups
For a firewall policy resource, you can specify the following operations in the Actions section of the statement:
network-firewall:CreateFirewall
network-firewall:UpdateFirewall
network-firewall:AssociateFirewallPolicy
network-firewall:ListFirewallPolicies
In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in Arn.
The Amazon Resource Name (ARN) of the firewall.
", "UpdateFirewallDescriptionRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallDescriptionResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", + "UpdateFirewallEncryptionConfigurationRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", + "UpdateFirewallEncryptionConfigurationResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateFirewallPolicyChangeProtectionRequest$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallPolicyChangeProtectionResponse$FirewallArn": "The Amazon Resource Name (ARN) of the firewall.
", "UpdateFirewallPolicyRequest$FirewallPolicyArn": "The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
", @@ -829,6 +859,8 @@ "UpdateFirewallDeleteProtectionResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateFirewallDescriptionRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallDescriptionResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", + "UpdateFirewallEncryptionConfigurationRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", + "UpdateFirewallEncryptionConfigurationResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateFirewallPolicyChangeProtectionRequest$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
", "UpdateFirewallPolicyChangeProtectionResponse$FirewallName": "The descriptive name of the firewall. You can't change the name of a firewall after you create it.
", "UpdateFirewallPolicyRequest$FirewallPolicyName": "The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
", @@ -868,16 +900,16 @@ } }, "RuleDefinition": { - "base": "The inspection criteria and action for a single stateless rule. AWS Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.
", + "base": "The inspection criteria and action for a single stateless rule. Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.
", "refs": { "StatelessRule$RuleDefinition": "Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria.
" } }, "RuleGroup": { - "base": "The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
AWS Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
", + "base": "The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
", "refs": { "CreateRuleGroupRequest$RuleGroup": "An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
AWS Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
", + "DescribeRuleGroupResponse$RuleGroup": "The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
", "UpdateRuleGroupRequest$RuleGroup": "An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
Indicates how to manage the order of stateful rule evaluation for the policy. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the AWS Network Firewall Developer Guide.
Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the AWS Network Firewall Developer Guide.
Indicates how to manage the order of stateful rule evaluation for the policy. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
Stateful inspection criteria for a domain list rule group.
For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in AWS Network Firewall in the Network Firewall Developer Guide.
Stateful inspection criteria for a domain list rule group.
For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.
Stateful inspection criteria for a domain list rule group.
" } @@ -999,7 +1031,7 @@ "StatefulActions": { "base": null, "refs": { - "FirewallPolicy$StatefulDefaultActions": "The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
Valid values of the stateful default action:
aws:drop_strict
aws:drop_established
aws:alert_strict
aws:alert_established
For more information, see Strict evaluation order in the AWS Network Firewall Developer Guide.
" + "FirewallPolicy$StatefulDefaultActions": "The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
Valid values of the stateful default action:
aws:drop_strict
aws:drop_established
aws:alert_strict
aws:alert_established
For more information, see Strict evaluation order in the Network Firewall Developer Guide.
" } }, "StatefulEngineOptions": { @@ -1048,7 +1080,7 @@ "StatefulRuleProtocol": { "base": null, "refs": { - "Header$Protocol": "The protocol to inspect for. To specify all, you can use IP, because all traffic on AWS and on the internet is IP.
The protocol to inspect for. To specify all, you can use IP, because all traffic on Amazon Web Services and on the internet is IP.
The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. AWS Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
", + "base": "The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
", "refs": { "SubnetMappings$member": null } @@ -1112,7 +1144,7 @@ } }, "SyncState": { - "base": "The status of the firewall endpoint and firewall policy configuration for a single VPC subnet.
For each VPC subnet that you associate with a firewall, AWS Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
", + "base": "The status of the firewall endpoint and firewall policy configuration for a single VPC subnet.
For each VPC subnet that you associate with a firewall, Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
", "refs": { "SyncStates$value": null } @@ -1148,7 +1180,7 @@ } }, "Tag": { - "base": "A key:value pair associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource.
", + "base": "A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each Amazon Web Services resource.
", "refs": { "TagList$member": null } @@ -1253,6 +1285,16 @@ "refs": { } }, + "UpdateFirewallEncryptionConfigurationRequest": { + "base": null, + "refs": { + } + }, + "UpdateFirewallEncryptionConfigurationResponse": { + "base": null, + "refs": { + } + }, "UpdateFirewallPolicyChangeProtectionRequest": { "base": null, "refs": { @@ -1322,6 +1364,8 @@ "UpdateFirewallDeleteProtectionResponse$UpdateToken": "An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
Amazon Web Services Price List Service API (Amazon Web Services Price List Service) is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List Service uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List Service to build cost control and scenario planning tools, reconcile billing data, forecast future spend for budgeting purposes, and provide cost benefit analysis that compare your internal workloads with Amazon Web Services.
Use GetServices without a service code to retrieve the service codes for all AWS services, then GetServices with a service code to retreive the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
Service Endpoint
Amazon Web Services Price List Service API provides the following two endpoints:
https://api.pricing.us-east-1.amazonaws.com
https://api.pricing.ap-south-1.amazonaws.com
Amazon Web Services Price List Service API (Amazon Web Services Price List Service) is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List Service uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List Service to build cost control and scenario planning tools, reconcile billing data, forecast future spend for budgeting purposes, and provide cost benefit analysis that compare your internal workloads with Amazon Web Services.
Use GetServices without a service code to retrieve the service codes for all AWS services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
Service Endpoint
Amazon Web Services Price List Service API provides the following two endpoints:
https://api.pricing.us-east-1.amazonaws.com
https://api.pricing.ap-south-1.amazonaws.com
Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.
Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Amazon Web Services Billing and Cost Management User Guide.
", + "GetAttributeValues": "Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Amazon Web Services Billing and Cost Management User Guide.
", "GetProducts": "Returns a list of all products that match the filter criteria.
" }, "shapes": { @@ -139,7 +139,7 @@ "DescribeServicesRequest$FormatVersion": "The format version that you want the response to be in.
Valid values are: aws_v1
The pagination token that indicates the next set of results that you want to retrieve.
", "DescribeServicesResponse$FormatVersion": "The format version of the response. For example, aws_v1.
The pagination token for the next set of retreivable results.
", + "DescribeServicesResponse$NextToken": "The pagination token for the next set of retrievable results.
", "Filter$Field": "The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.
Valid values include: ServiceCode, and all attribute names
For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.
The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.
The service code for the service whose attributes you want to retrieve. For example, if you want the retrieve an EC2 attribute, use AmazonEC2.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.
The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>\"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
", + "RecommendationJobOutputConfig$KmsKeyId": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>\"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
", "RedshiftDatasetDefinition$KmsKeyId": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
", "ResourceConfig$VolumeKmsKeyId": "The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
The Amazon Web Services Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.
The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:
\"kms:GenerateDataKey\"
The Amazon Resource Name (ARN) of the recommendation job.
" } }, + "RecommendationJobCompiledOutputConfig": { + "base": "Provides information about the output configuration for the compiled model.
", + "refs": { + "RecommendationJobOutputConfig$CompiledOutputConfig": "Provides information about the output configuration for the compiled model.
" + } + }, "RecommendationJobDescription": { "base": null, "refs": { @@ -8976,6 +8984,12 @@ "StopInferenceRecommendationsJobRequest$JobName": "The name of the job you want to stop.
" } }, + "RecommendationJobOutputConfig": { + "base": "Provides information about the output configuration for the compiled model.
", + "refs": { + "CreateInferenceRecommendationsJobRequest$OutputConfig": "Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
" + } + }, "RecommendationJobResourceLimit": { "base": "Specifies the maximum number of jobs that can run in parallel and the maximum number of jobs that can run.
", "refs": { @@ -9401,6 +9415,7 @@ "ProfilerConfig$S3OutputPath": "Path to Amazon S3 storage location for system and framework metrics.
", "ProfilerConfigForUpdate$S3OutputPath": "Path to Amazon S3 storage location for system and framework metrics.
", "ProfilerRuleConfiguration$S3OutputPath": "Path to Amazon S3 storage location for rules.
", + "RecommendationJobCompiledOutputConfig$S3OutputUri": "Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
", "RedshiftDatasetDefinition$OutputS3Uri": "The location in Amazon S3 where the Redshift query results are stored.
", "S3DataSource$S3Uri": "Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest
A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
[ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},
\"relative/path/to/custdata-1\",
\"relative/path/custdata-2\",
...
\"relative/path/custdata-N\"
]
This JSON is equivalent to the following S3Uri list:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-2
...
s3://customer_bucket/some/prefix/relative/path/custdata-N
The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
Resources
The following resource is part of Amazon +// IVS Chat:
Room — The central Amazon IVS Chat +// resource through which clients connect to and exchange chat messages. +// See the Room endpoints for more information.
API +// Access Security
Your Amazon IVS Chat applications (service +// applications and clients) must be authenticated and authorized to access +// Amazon IVS Chat resources. Note the differences between these concepts:
+//Authentication is about verifying identity. Requests +// to the Amazon IVS Chat API must be signed to verify your identity.
+//Authorization is about granting permissions. Your +// IAM roles need to have permissions for Amazon IVS Chat API requests.
+//Users (viewers) connect to a room using secure access tokens +// that you create using the CreateChatToken endpoint through the +// AWS SDK. You call CreateChatToken for every user’s chat session, passing +// identity and authorization information about the user.
Signing +// API Requests
HTTP API requests must be signed with an AWS +// SigV4 signature using your AWS security credentials. The AWS Command Line +// Interface (CLI) and the AWS SDKs take care of signing the underlying API +// calls for you. However, if your application calls the Amazon IVS Chat +// HTTP API directly, it’s your responsibility to sign the requests.
+//You generate a signature using valid AWS credentials for an IAM role
+// that has permission to perform the requested action. For example, DeleteMessage
+// requests must be made using an IAM role that has the ivschat:DeleteMessage
+// permission.
For more information:
Authentication +// and generating signatures — See Authenticating +// Requests (Amazon Web Services Signature Version 4) in the Amazon +// Web Services General Reference.
Managing Amazon +// IVS permissions — See Identity +// and Access Management on the Security page of the Amazon IVS User +// Guide.
Messaging Endpoints
DeleteMessage — Sends an event to a specific room which directs
+// clients to delete a specific message; that is, unrender it from view and
+// delete it from the client’s chat history. This event’s EventName
+// is aws:DELETE_MESSAGE. This replicates the
+// DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging
+// API.
DisconnectUser — Disconnects all connections +// using a specified user ID from a room. This replicates the +// DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging +// API.
SendEvent — Sends an event to a room. +// Use this within your application’s business logic to send events to +// clients of a room; e.g., to notify clients to change the way the chat +// UI is rendered.
Chat Token Endpoint
CreateChatToken — Creates an encrypted token that is +// used to establish an individual WebSocket connection to a room. The token +// is valid for one minute, and a connection (session) established with the +// token is valid for the specified duration.
Room +// Endpoints
CreateRoom — Creates a room +// that allows clients to connect and pass messages.
DeleteRoom +// — Deletes the specified room.
GetRoom — +// Gets the specified room.
ListRooms — Gets +// summary information about all your rooms in the AWS region where the API +// request is processed.
UpdateRoom — Updates +// a room’s configuration.
Tags Endpoints
+//ListTagsForResource — Gets information about AWS +// tags for the specified ARN.
TagResource — +// Adds or updates tags for the AWS resource with the specified ARN.
+//UntagResource — Removes tags from the resource +// with the specified ARN.
All the above are HTTP operations. +// There is a separate messaging API for managing Chat resources; +// see the +// Amazon IVS Chat Messaging API Reference.
+// +// See https://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14 for more information on this service. +// +// See ivschat package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/ivschat/ +// +// Using the Client +// +// To contact Amazon Interactive Video Service Chat with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the Amazon Interactive Video Service Chat client Ivschat for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/ivschat/#New +package ivschat diff --git a/service/ivschat/errors.go b/service/ivschat/errors.go new file mode 100644 index 00000000000..31c91fdd57b --- /dev/null +++ b/service/ivschat/errors.go @@ -0,0 +1,53 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package ivschat + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + ErrCodeAccessDeniedException = "AccessDeniedException" + + // ErrCodeConflictException for service response error code + // "ConflictException". + ErrCodeConflictException = "ConflictException" + + // ErrCodeInternalServerException for service response error code + // "InternalServerException". + ErrCodeInternalServerException = "InternalServerException" + + // ErrCodePendingVerification for service response error code + // "PendingVerification". + ErrCodePendingVerification = "PendingVerification" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + + // ErrCodeThrottlingException for service response error code + // "ThrottlingException". + ErrCodeThrottlingException = "ThrottlingException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "AccessDeniedException": newErrorAccessDeniedException, + "ConflictException": newErrorConflictException, + "InternalServerException": newErrorInternalServerException, + "PendingVerification": newErrorPendingVerification, + "ResourceNotFoundException": newErrorResourceNotFoundException, + "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "ThrottlingException": newErrorThrottlingException, + "ValidationException": newErrorValidationException, +} diff --git a/service/ivschat/ivschatiface/interface.go b/service/ivschat/ivschatiface/interface.go new file mode 100644 index 00000000000..fdc9e3f8d14 --- /dev/null +++ b/service/ivschat/ivschatiface/interface.go @@ -0,0 +1,115 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package ivschatiface provides an interface to enable mocking the Amazon Interactive Video Service Chat service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package ivschatiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/ivschat" +) + +// IvschatAPI provides an interface to enable mocking the +// ivschat.Ivschat service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // Amazon Interactive Video Service Chat. +// func myFunc(svc ivschatiface.IvschatAPI) bool { +// // Make svc.CreateChatToken request +// } +// +// func main() { +// sess := session.New() +// svc := ivschat.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockIvschatClient struct { +// ivschatiface.IvschatAPI +// } +// func (m *mockIvschatClient) CreateChatToken(input *ivschat.CreateChatTokenInput) (*ivschat.CreateChatTokenOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockIvschatClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type IvschatAPI interface { + CreateChatToken(*ivschat.CreateChatTokenInput) (*ivschat.CreateChatTokenOutput, error) + CreateChatTokenWithContext(aws.Context, *ivschat.CreateChatTokenInput, ...request.Option) (*ivschat.CreateChatTokenOutput, error) + CreateChatTokenRequest(*ivschat.CreateChatTokenInput) (*request.Request, *ivschat.CreateChatTokenOutput) + + CreateRoom(*ivschat.CreateRoomInput) (*ivschat.CreateRoomOutput, error) + CreateRoomWithContext(aws.Context, *ivschat.CreateRoomInput, ...request.Option) (*ivschat.CreateRoomOutput, error) + CreateRoomRequest(*ivschat.CreateRoomInput) (*request.Request, *ivschat.CreateRoomOutput) + + DeleteMessage(*ivschat.DeleteMessageInput) (*ivschat.DeleteMessageOutput, error) + DeleteMessageWithContext(aws.Context, *ivschat.DeleteMessageInput, ...request.Option) (*ivschat.DeleteMessageOutput, error) + DeleteMessageRequest(*ivschat.DeleteMessageInput) (*request.Request, *ivschat.DeleteMessageOutput) + + DeleteRoom(*ivschat.DeleteRoomInput) (*ivschat.DeleteRoomOutput, error) + DeleteRoomWithContext(aws.Context, *ivschat.DeleteRoomInput, ...request.Option) (*ivschat.DeleteRoomOutput, error) + DeleteRoomRequest(*ivschat.DeleteRoomInput) (*request.Request, *ivschat.DeleteRoomOutput) + + DisconnectUser(*ivschat.DisconnectUserInput) (*ivschat.DisconnectUserOutput, error) + DisconnectUserWithContext(aws.Context, *ivschat.DisconnectUserInput, ...request.Option) (*ivschat.DisconnectUserOutput, error) + DisconnectUserRequest(*ivschat.DisconnectUserInput) (*request.Request, *ivschat.DisconnectUserOutput) + + GetRoom(*ivschat.GetRoomInput) (*ivschat.GetRoomOutput, error) + GetRoomWithContext(aws.Context, *ivschat.GetRoomInput, ...request.Option) (*ivschat.GetRoomOutput, error) + GetRoomRequest(*ivschat.GetRoomInput) (*request.Request, *ivschat.GetRoomOutput) + + ListRooms(*ivschat.ListRoomsInput) (*ivschat.ListRoomsOutput, error) + ListRoomsWithContext(aws.Context, *ivschat.ListRoomsInput, ...request.Option) (*ivschat.ListRoomsOutput, error) + ListRoomsRequest(*ivschat.ListRoomsInput) (*request.Request, *ivschat.ListRoomsOutput) + + ListRoomsPages(*ivschat.ListRoomsInput, func(*ivschat.ListRoomsOutput, bool) bool) error + ListRoomsPagesWithContext(aws.Context, *ivschat.ListRoomsInput, func(*ivschat.ListRoomsOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*ivschat.ListTagsForResourceInput) (*ivschat.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *ivschat.ListTagsForResourceInput, ...request.Option) (*ivschat.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*ivschat.ListTagsForResourceInput) (*request.Request, *ivschat.ListTagsForResourceOutput) + + SendEvent(*ivschat.SendEventInput) (*ivschat.SendEventOutput, error) + SendEventWithContext(aws.Context, *ivschat.SendEventInput, ...request.Option) (*ivschat.SendEventOutput, error) + SendEventRequest(*ivschat.SendEventInput) (*request.Request, *ivschat.SendEventOutput) + + TagResource(*ivschat.TagResourceInput) (*ivschat.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *ivschat.TagResourceInput, ...request.Option) (*ivschat.TagResourceOutput, error) + TagResourceRequest(*ivschat.TagResourceInput) (*request.Request, *ivschat.TagResourceOutput) + + UntagResource(*ivschat.UntagResourceInput) (*ivschat.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *ivschat.UntagResourceInput, ...request.Option) (*ivschat.UntagResourceOutput, error) + UntagResourceRequest(*ivschat.UntagResourceInput) (*request.Request, *ivschat.UntagResourceOutput) + + UpdateRoom(*ivschat.UpdateRoomInput) (*ivschat.UpdateRoomOutput, error) + UpdateRoomWithContext(aws.Context, *ivschat.UpdateRoomInput, ...request.Option) (*ivschat.UpdateRoomOutput, error) + UpdateRoomRequest(*ivschat.UpdateRoomInput) (*request.Request, *ivschat.UpdateRoomOutput) +} + +var _ IvschatAPI = (*ivschat.Ivschat)(nil) diff --git a/service/ivschat/service.go b/service/ivschat/service.go new file mode 100644 index 00000000000..3a0ba88d11e --- /dev/null +++ b/service/ivschat/service.go @@ -0,0 +1,105 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package ivschat + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// Ivschat provides the API operation methods for making requests to +// Amazon Interactive Video Service Chat. See this package's package overview docs +// for details on the service. +// +// Ivschat methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type Ivschat struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "ivschat" // Name of service. + EndpointsID = ServiceName // ID to lookup a service endpoint with. + ServiceID = "ivschat" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the Ivschat client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a Ivschat client from just a session. +// svc := ivschat.New(mySession) +// +// // Create a Ivschat client with additional configuration +// svc := ivschat.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *Ivschat { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "ivschat" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName, c.ResolvedRegion) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName, resolvedRegion string) *Ivschat { + svc := &Ivschat{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2020-07-14", + ResolvedRegion: resolvedRegion, + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a Ivschat operation and runs any +// custom request initialization. +func (c *Ivschat) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/lightsail/api.go b/service/lightsail/api.go index 0123f617032..dea9c8dfa1a 100644 --- a/service/lightsail/api.go +++ b/service/lightsail/api.go @@ -75,8 +75,8 @@ func (c *Lightsail) AllocateStaticIpRequest(input *AllocateStaticIpInput) (req * // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -170,10 +170,11 @@ func (c *Lightsail) AttachCertificateToDistributionRequest(input *AttachCertific // Use the CreateCertificate action to create a certificate that you can attach // to your distribution. // -// Only certificates created in the us-east-1 AWS Region can be attached to -// Lightsail distributions. Lightsail distributions are global resources that -// can reference an origin in any AWS Region, and distribute its content globally. -// However, all distributions are located in the us-east-1 Region. +// Only certificates created in the us-east-1 Amazon Web Services Region can +// be attached to Lightsail distributions. Lightsail distributions are global +// resources that can reference an origin in any Amazon Web Services Region, +// and distribute its content globally. However, all distributions are located +// in the us-east-1 Region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -191,8 +192,8 @@ func (c *Lightsail) AttachCertificateToDistributionRequest(input *AttachCertific // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -296,8 +297,8 @@ func (c *Lightsail) AttachDiskRequest(input *AttachDiskInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -407,8 +408,8 @@ func (c *Lightsail) AttachInstancesToLoadBalancerRequest(input *AttachInstancesT // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -522,8 +523,8 @@ func (c *Lightsail) AttachLoadBalancerTlsCertificateRequest(input *AttachLoadBal // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -626,8 +627,8 @@ func (c *Lightsail) AttachStaticIpRequest(input *AttachStaticIpInput) (req *requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -734,8 +735,8 @@ func (c *Lightsail) CloseInstancePublicPortsRequest(input *CloseInstancePublicPo // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -823,7 +824,8 @@ func (c *Lightsail) CopySnapshotRequest(input *CopySnapshotInput) (req *request. // Copies a manual snapshot of an instance or disk as another manual snapshot, // or copies an automatic snapshot of an instance or disk as a manual snapshot. // This operation can also be used to copy a manual or automatic snapshot of -// an instance or a disk from one AWS Region to another in Amazon Lightsail. +// an instance or a disk from one Amazon Web Services Region to another in Amazon +// Lightsail. // // When copying a manual snapshot, be sure to define the source region, source // snapshot name, and target snapshot name parameters. @@ -848,8 +850,8 @@ func (c *Lightsail) CopySnapshotRequest(input *CopySnapshotInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -958,8 +960,8 @@ func (c *Lightsail) CreateBucketRequest(input *CreateBucketInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * ServiceException // A general service exception. @@ -1069,8 +1071,8 @@ func (c *Lightsail) CreateBucketAccessKeyRequest(input *CreateBucketAccessKeyInp // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * ServiceException // A general service exception. @@ -1152,10 +1154,11 @@ func (c *Lightsail) CreateCertificateRequest(input *CreateCertificateInput) (req // UpdateContainerService action to use the certificate and its domains with // your container service. // -// Only certificates created in the us-east-1 AWS Region can be attached to -// Lightsail distributions. Lightsail distributions are global resources that -// can reference an origin in any AWS Region, and distribute its content globally. -// However, all distributions are located in the us-east-1 Region. +// Only certificates created in the us-east-1 Amazon Web Services Region can +// be attached to Lightsail distributions. Lightsail distributions are global +// resources that can reference an origin in any Amazon Web Services Region, +// and distribute its content globally. However, all distributions are located +// in the us-east-1 Region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1173,8 +1176,8 @@ func (c *Lightsail) CreateCertificateRequest(input *CreateCertificateInput) (req // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -1278,8 +1281,8 @@ func (c *Lightsail) CreateCloudFormationStackRequest(input *CreateCloudFormation // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -1368,9 +1371,10 @@ func (c *Lightsail) CreateContactMethodRequest(input *CreateContactMethodInput) // // 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 AWS Region. However, SMS text messaging is not supported in -// some AWS Regions, and SMS text messages cannot be sent to some countries/regions. -// For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). +// 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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1388,8 +1392,8 @@ func (c *Lightsail) CreateContactMethodRequest(input *CreateContactMethodInput) // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -1493,8 +1497,8 @@ func (c *Lightsail) CreateContainerServiceRequest(input *CreateContainerServiceI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -1602,8 +1606,8 @@ func (c *Lightsail) CreateContainerServiceDeploymentRequest(input *CreateContain // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -1719,8 +1723,8 @@ func (c *Lightsail) CreateContainerServiceRegistryLoginRequest(input *CreateCont // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -1820,8 +1824,8 @@ func (c *Lightsail) CreateDiskRequest(input *CreateDiskInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -1931,8 +1935,8 @@ func (c *Lightsail) CreateDiskFromSnapshotRequest(input *CreateDiskFromSnapshotI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2062,8 +2066,8 @@ func (c *Lightsail) CreateDiskSnapshotRequest(input *CreateDiskSnapshotInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2171,8 +2175,8 @@ func (c *Lightsail) CreateDistributionRequest(input *CreateDistributionInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2274,8 +2278,8 @@ func (c *Lightsail) CreateDomainRequest(input *CreateDomainInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2384,8 +2388,8 @@ func (c *Lightsail) CreateDomainEntryRequest(input *CreateDomainEntryInput) (req // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2493,8 +2497,8 @@ func (c *Lightsail) CreateInstanceSnapshotRequest(input *CreateInstanceSnapshotI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2600,8 +2604,8 @@ func (c *Lightsail) CreateInstancesRequest(input *CreateInstancesInput) (req *re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2710,8 +2714,8 @@ func (c *Lightsail) CreateInstancesFromSnapshotRequest(input *CreateInstancesFro // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2821,8 +2825,8 @@ func (c *Lightsail) CreateKeyPairRequest(input *CreateKeyPairInput) (req *reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -2936,8 +2940,8 @@ func (c *Lightsail) CreateLoadBalancerRequest(input *CreateLoadBalancerInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -3046,8 +3050,8 @@ func (c *Lightsail) CreateLoadBalancerTlsCertificateRequest(input *CreateLoadBal // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -3154,8 +3158,8 @@ func (c *Lightsail) CreateRelationalDatabaseRequest(input *CreateRelationalDatab // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -3267,8 +3271,8 @@ func (c *Lightsail) CreateRelationalDatabaseFromSnapshotRequest(input *CreateRel // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -3377,8 +3381,8 @@ func (c *Lightsail) CreateRelationalDatabaseSnapshotRequest(input *CreateRelatio // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -3486,8 +3490,8 @@ func (c *Lightsail) DeleteAlarmRequest(input *DeleteAlarmInput) (req *request.Re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * OperationFailureException // Lightsail throws this exception when an operation fails to execute. @@ -3587,8 +3591,8 @@ func (c *Lightsail) DeleteAutoSnapshotRequest(input *DeleteAutoSnapshotInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -3672,7 +3676,7 @@ func (c *Lightsail) DeleteBucketRequest(input *DeleteBucketInput) (req *request. // Deletes a Amazon Lightsail bucket. // // When you delete your bucket, the bucket name is released and can be reused -// for a new bucket in your account or another AWS account. +// for a new bucket in your account or another Amazon Web Services account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3691,8 +3695,8 @@ func (c *Lightsail) DeleteBucketRequest(input *DeleteBucketInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -3794,8 +3798,8 @@ func (c *Lightsail) DeleteBucketAccessKeyRequest(input *DeleteBucketAccessKeyInp // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -3895,8 +3899,8 @@ func (c *Lightsail) DeleteCertificateRequest(input *DeleteCertificateInput) (req // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * AccessDeniedException // Lightsail throws this exception when the user cannot be authenticated or @@ -3978,9 +3982,10 @@ func (c *Lightsail) DeleteContactMethodRequest(input *DeleteContactMethodInput) // // 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 AWS Region. However, SMS text messaging is not supported in -// some AWS Regions, and SMS text messages cannot be sent to some countries/regions. -// For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). +// 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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3998,8 +4003,8 @@ func (c *Lightsail) DeleteContactMethodRequest(input *DeleteContactMethodInput) // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * OperationFailureException // Lightsail throws this exception when an operation fails to execute. @@ -4100,8 +4105,8 @@ func (c *Lightsail) DeleteContainerImageRequest(input *DeleteContainerImageInput // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -4198,8 +4203,8 @@ func (c *Lightsail) DeleteContainerServiceRequest(input *DeleteContainerServiceI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -4302,8 +4307,8 @@ func (c *Lightsail) DeleteDiskRequest(input *DeleteDiskInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -4417,8 +4422,8 @@ func (c *Lightsail) DeleteDiskSnapshotRequest(input *DeleteDiskSnapshotInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -4521,8 +4526,8 @@ func (c *Lightsail) DeleteDistributionRequest(input *DeleteDistributionInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -4625,8 +4630,8 @@ func (c *Lightsail) DeleteDomainRequest(input *DeleteDomainInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -4733,8 +4738,8 @@ func (c *Lightsail) DeleteDomainEntryRequest(input *DeleteDomainEntryInput) (req // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -4841,8 +4846,8 @@ func (c *Lightsail) DeleteInstanceRequest(input *DeleteInstanceInput) (req *requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -4949,8 +4954,8 @@ func (c *Lightsail) DeleteInstanceSnapshotRequest(input *DeleteInstanceSnapshotI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5064,8 +5069,8 @@ func (c *Lightsail) DeleteKeyPairRequest(input *DeleteKeyPairInput) (req *reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5176,8 +5181,8 @@ func (c *Lightsail) DeleteKnownHostKeysRequest(input *DeleteKnownHostKeysInput) // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5286,8 +5291,8 @@ func (c *Lightsail) DeleteLoadBalancerRequest(input *DeleteLoadBalancerInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5394,8 +5399,8 @@ func (c *Lightsail) DeleteLoadBalancerTlsCertificateRequest(input *DeleteLoadBal // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5502,8 +5507,8 @@ func (c *Lightsail) DeleteRelationalDatabaseRequest(input *DeleteRelationalDatab // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5610,8 +5615,8 @@ func (c *Lightsail) DeleteRelationalDatabaseSnapshotRequest(input *DeleteRelatio // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5718,8 +5723,8 @@ func (c *Lightsail) DetachCertificateFromDistributionRequest(input *DetachCertif // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5824,8 +5829,8 @@ func (c *Lightsail) DetachDiskRequest(input *DetachDiskInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -5935,8 +5940,8 @@ func (c *Lightsail) DetachInstancesFromLoadBalancerRequest(input *DetachInstance // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -6039,8 +6044,8 @@ func (c *Lightsail) DetachStaticIpRequest(input *DetachStaticIpInput) (req *requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -6144,8 +6149,8 @@ func (c *Lightsail) DisableAddOnRequest(input *DisableAddOnInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -6247,8 +6252,8 @@ func (c *Lightsail) DownloadDefaultKeyPairRequest(input *DownloadDefaultKeyPairI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -6352,8 +6357,8 @@ func (c *Lightsail) EnableAddOnRequest(input *EnableAddOnInput) (req *request.Re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -6468,8 +6473,8 @@ func (c *Lightsail) ExportSnapshotRequest(input *ExportSnapshotInput) (req *requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -6572,8 +6577,8 @@ func (c *Lightsail) GetActiveNamesRequest(input *GetActiveNamesInput) (req *requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -6683,8 +6688,8 @@ func (c *Lightsail) GetAlarmsRequest(input *GetAlarmsInput) (req *request.Reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * OperationFailureException // Lightsail throws this exception when an operation fails to execute. @@ -6784,8 +6789,8 @@ func (c *Lightsail) GetAutoSnapshotsRequest(input *GetAutoSnapshotsInput) (req * // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -6892,8 +6897,8 @@ func (c *Lightsail) GetBlueprintsRequest(input *GetBlueprintsInput) (req *reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -7002,8 +7007,8 @@ func (c *Lightsail) GetBucketAccessKeysRequest(input *GetBucketAccessKeysInput) // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -7105,8 +7110,8 @@ func (c *Lightsail) GetBucketBundlesRequest(input *GetBucketBundlesInput) (req * // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * ServiceException // A general service exception. @@ -7203,8 +7208,8 @@ func (c *Lightsail) GetBucketMetricDataRequest(input *GetBucketMetricDataInput) // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -7306,8 +7311,8 @@ func (c *Lightsail) GetBucketsRequest(input *GetBucketsInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -7403,8 +7408,8 @@ func (c *Lightsail) GetBundlesRequest(input *GetBundlesInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -7511,8 +7516,8 @@ func (c *Lightsail) GetCertificatesRequest(input *GetCertificatesInput) (req *re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -7612,8 +7617,8 @@ func (c *Lightsail) GetCloudFormationStackRecordsRequest(input *GetCloudFormatio // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -7703,9 +7708,10 @@ func (c *Lightsail) GetContactMethodsRequest(input *GetContactMethodsInput) (req // // 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 AWS Region. However, SMS text messaging is not supported in -// some AWS Regions, and SMS text messages cannot be sent to some countries/regions. -// For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). +// 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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7723,8 +7729,8 @@ func (c *Lightsail) GetContactMethodsRequest(input *GetContactMethodsInput) (req // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -7916,8 +7922,8 @@ func (c *Lightsail) GetContainerImagesRequest(input *GetContainerImagesInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8022,8 +8028,8 @@ func (c *Lightsail) GetContainerLogRequest(input *GetContainerLogInput) (req *re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8130,8 +8136,8 @@ func (c *Lightsail) GetContainerServiceDeploymentsRequest(input *GetContainerSer // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8232,8 +8238,8 @@ func (c *Lightsail) GetContainerServiceMetricDataRequest(input *GetContainerServ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8333,8 +8339,8 @@ func (c *Lightsail) GetContainerServicePowersRequest(input *GetContainerServiceP // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8431,8 +8437,8 @@ func (c *Lightsail) GetContainerServicesRequest(input *GetContainerServicesInput // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8528,8 +8534,8 @@ func (c *Lightsail) GetDiskRequest(input *GetDiskInput) (req *request.Request, o // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8632,8 +8638,8 @@ func (c *Lightsail) GetDiskSnapshotRequest(input *GetDiskSnapshotInput) (req *re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8737,8 +8743,8 @@ func (c *Lightsail) GetDiskSnapshotsRequest(input *GetDiskSnapshotsInput) (req * // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8842,8 +8848,8 @@ func (c *Lightsail) GetDisksRequest(input *GetDisksInput) (req *request.Request, // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -8950,8 +8956,8 @@ func (c *Lightsail) GetDistributionBundlesRequest(input *GetDistributionBundlesI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9051,8 +9057,8 @@ func (c *Lightsail) GetDistributionLatestCacheResetRequest(input *GetDistributio // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9156,8 +9162,8 @@ func (c *Lightsail) GetDistributionMetricDataRequest(input *GetDistributionMetri // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9257,8 +9263,8 @@ func (c *Lightsail) GetDistributionsRequest(input *GetDistributionsInput) (req * // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9357,8 +9363,8 @@ func (c *Lightsail) GetDomainRequest(input *GetDomainInput) (req *request.Reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9461,8 +9467,8 @@ func (c *Lightsail) GetDomainsRequest(input *GetDomainsInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9570,8 +9576,8 @@ func (c *Lightsail) GetExportSnapshotRecordsRequest(input *GetExportSnapshotReco // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9675,8 +9681,8 @@ func (c *Lightsail) GetInstanceRequest(input *GetInstanceInput) (req *request.Re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9784,8 +9790,8 @@ func (c *Lightsail) GetInstanceAccessDetailsRequest(input *GetInstanceAccessDeta // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9893,8 +9899,8 @@ func (c *Lightsail) GetInstanceMetricDataRequest(input *GetInstanceMetricDataInp // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -9999,8 +10005,8 @@ func (c *Lightsail) GetInstancePortStatesRequest(input *GetInstancePortStatesInp // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10103,8 +10109,8 @@ func (c *Lightsail) GetInstanceSnapshotRequest(input *GetInstanceSnapshotInput) // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10207,8 +10213,8 @@ func (c *Lightsail) GetInstanceSnapshotsRequest(input *GetInstanceSnapshotsInput // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10311,8 +10317,8 @@ func (c *Lightsail) GetInstanceStateRequest(input *GetInstanceStateInput) (req * // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10416,8 +10422,8 @@ func (c *Lightsail) GetInstancesRequest(input *GetInstancesInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10520,8 +10526,8 @@ func (c *Lightsail) GetKeyPairRequest(input *GetKeyPairInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10624,8 +10630,8 @@ func (c *Lightsail) GetKeyPairsRequest(input *GetKeyPairsInput) (req *request.Re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10728,8 +10734,8 @@ func (c *Lightsail) GetLoadBalancerRequest(input *GetLoadBalancerInput) (req *re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10836,8 +10842,8 @@ func (c *Lightsail) GetLoadBalancerMetricDataRequest(input *GetLoadBalancerMetri // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10946,8 +10952,8 @@ func (c *Lightsail) GetLoadBalancerTlsCertificatesRequest(input *GetLoadBalancer // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -10988,6 +10994,109 @@ func (c *Lightsail) GetLoadBalancerTlsCertificatesWithContext(ctx aws.Context, i return out, req.Send() } +const opGetLoadBalancerTlsPolicies = "GetLoadBalancerTlsPolicies" + +// GetLoadBalancerTlsPoliciesRequest generates a "aws/request.Request" representing the +// client's request for the GetLoadBalancerTlsPolicies operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetLoadBalancerTlsPolicies for more information on using the GetLoadBalancerTlsPolicies +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetLoadBalancerTlsPoliciesRequest method. +// req, resp := client.GetLoadBalancerTlsPoliciesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsPolicies +func (c *Lightsail) GetLoadBalancerTlsPoliciesRequest(input *GetLoadBalancerTlsPoliciesInput) (req *request.Request, output *GetLoadBalancerTlsPoliciesOutput) { + op := &request.Operation{ + Name: opGetLoadBalancerTlsPolicies, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetLoadBalancerTlsPoliciesInput{} + } + + output = &GetLoadBalancerTlsPoliciesOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetLoadBalancerTlsPolicies API operation for Amazon Lightsail. +// +// Returns a list of TLS security policies that you can apply to Lightsail load +// balancers. +// +// For more information about load balancer TLS security policies, see Load +// balancer TLS security policies (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) +// in the Amazon Lightsail Developer Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lightsail's +// API operation GetLoadBalancerTlsPolicies for usage and error information. +// +// Returned Error Types: +// * ServiceException +// A general service exception. +// +// * AccessDeniedException +// Lightsail throws this exception when the user cannot be authenticated or +// uses invalid credentials to access a resource. +// +// * AccountSetupInProgressException +// Lightsail throws this exception when an account is still in the setup in +// progress state. +// +// * UnauthenticatedException +// Lightsail throws this exception when the user has not been authenticated. +// +// * InvalidInputException +// 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. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsPolicies +func (c *Lightsail) GetLoadBalancerTlsPolicies(input *GetLoadBalancerTlsPoliciesInput) (*GetLoadBalancerTlsPoliciesOutput, error) { + req, out := c.GetLoadBalancerTlsPoliciesRequest(input) + return out, req.Send() +} + +// GetLoadBalancerTlsPoliciesWithContext is the same as GetLoadBalancerTlsPolicies with the addition of +// the ability to pass a context and additional request options. +// +// See GetLoadBalancerTlsPolicies for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Lightsail) GetLoadBalancerTlsPoliciesWithContext(ctx aws.Context, input *GetLoadBalancerTlsPoliciesInput, opts ...request.Option) (*GetLoadBalancerTlsPoliciesOutput, error) { + req, out := c.GetLoadBalancerTlsPoliciesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetLoadBalancers = "GetLoadBalancers" // GetLoadBalancersRequest generates a "aws/request.Request" representing the @@ -11050,8 +11159,8 @@ func (c *Lightsail) GetLoadBalancersRequest(input *GetLoadBalancersInput) (req * // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -11156,8 +11265,8 @@ func (c *Lightsail) GetOperationRequest(input *GetOperationInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -11264,8 +11373,8 @@ func (c *Lightsail) GetOperationsRequest(input *GetOperationsInput) (req *reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -11368,8 +11477,8 @@ func (c *Lightsail) GetOperationsForResourceRequest(input *GetOperationsForResou // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -11473,8 +11582,8 @@ func (c *Lightsail) GetRegionsRequest(input *GetRegionsInput) (req *request.Requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -11577,8 +11686,8 @@ func (c *Lightsail) GetRelationalDatabaseRequest(input *GetRelationalDatabaseInp // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -11685,8 +11794,8 @@ func (c *Lightsail) GetRelationalDatabaseBlueprintsRequest(input *GetRelationalD // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -11793,8 +11902,8 @@ func (c *Lightsail) GetRelationalDatabaseBundlesRequest(input *GetRelationalData // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -11897,8 +12006,8 @@ func (c *Lightsail) GetRelationalDatabaseEventsRequest(input *GetRelationalDatab // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12001,8 +12110,8 @@ func (c *Lightsail) GetRelationalDatabaseLogEventsRequest(input *GetRelationalDa // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12106,8 +12215,8 @@ func (c *Lightsail) GetRelationalDatabaseLogStreamsRequest(input *GetRelationalD // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12214,8 +12323,8 @@ func (c *Lightsail) GetRelationalDatabaseMasterUserPasswordRequest(input *GetRel // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12323,8 +12432,8 @@ func (c *Lightsail) GetRelationalDatabaseMetricDataRequest(input *GetRelationalD // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12433,8 +12542,8 @@ func (c *Lightsail) GetRelationalDatabaseParametersRequest(input *GetRelationalD // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12537,8 +12646,8 @@ func (c *Lightsail) GetRelationalDatabaseSnapshotRequest(input *GetRelationalDat // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12641,8 +12750,8 @@ func (c *Lightsail) GetRelationalDatabaseSnapshotsRequest(input *GetRelationalDa // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12745,8 +12854,8 @@ func (c *Lightsail) GetRelationalDatabasesRequest(input *GetRelationalDatabasesI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12849,8 +12958,8 @@ func (c *Lightsail) GetStaticIpRequest(input *GetStaticIpInput) (req *request.Re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -12953,8 +13062,8 @@ func (c *Lightsail) GetStaticIpsRequest(input *GetStaticIpsInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -13057,8 +13166,8 @@ func (c *Lightsail) ImportKeyPairRequest(input *ImportKeyPairInput) (req *reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -13161,8 +13270,8 @@ func (c *Lightsail) IsVpcPeeredRequest(input *IsVpcPeeredInput) (req *request.Re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -13270,8 +13379,8 @@ func (c *Lightsail) OpenInstancePublicPortsRequest(input *OpenInstancePublicPort // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -13374,8 +13483,8 @@ func (c *Lightsail) PeerVpcRequest(input *PeerVpcInput) (req *request.Request, o // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -13491,8 +13600,8 @@ func (c *Lightsail) PutAlarmRequest(input *PutAlarmInput) (req *request.Request, // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * OperationFailureException // Lightsail throws this exception when an operation fails to execute. @@ -13600,8 +13709,8 @@ func (c *Lightsail) PutInstancePublicPortsRequest(input *PutInstancePublicPortsI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -13708,8 +13817,8 @@ func (c *Lightsail) RebootInstanceRequest(input *RebootInstanceInput) (req *requ // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -13816,8 +13925,8 @@ func (c *Lightsail) RebootRelationalDatabaseRequest(input *RebootRelationalDatab // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -13926,8 +14035,8 @@ func (c *Lightsail) RegisterContainerImageRequest(input *RegisterContainerImageI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -14023,8 +14132,8 @@ func (c *Lightsail) ReleaseStaticIpRequest(input *ReleaseStaticIpInput) (req *re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -14131,8 +14240,8 @@ func (c *Lightsail) ResetDistributionCacheRequest(input *ResetDistributionCacheI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -14218,9 +14327,10 @@ func (c *Lightsail) SendContactMethodVerificationRequest(input *SendContactMetho // // 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 AWS Region. However, SMS text messaging is not supported in -// some AWS Regions, and SMS text messages cannot be sent to some countries/regions. -// For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). +// 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 (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). // // 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 @@ -14245,8 +14355,8 @@ func (c *Lightsail) SendContactMethodVerificationRequest(input *SendContactMetho // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * OperationFailureException // Lightsail throws this exception when an operation fails to execute. @@ -14349,8 +14459,8 @@ func (c *Lightsail) SetIpAddressTypeRequest(input *SetIpAddressTypeInput) (req * // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -14439,7 +14549,7 @@ func (c *Lightsail) SetResourceAccessForBucketRequest(input *SetResourceAccessFo // bucket. // // Lightsail buckets currently support setting access for Lightsail instances -// in the same AWS Region. +// in the same Amazon Web Services Region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -14458,8 +14568,8 @@ func (c *Lightsail) SetResourceAccessForBucketRequest(input *SetResourceAccessFo // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -14564,8 +14674,8 @@ func (c *Lightsail) StartInstanceRequest(input *StartInstanceInput) (req *reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -14673,8 +14783,8 @@ func (c *Lightsail) StartRelationalDatabaseRequest(input *StartRelationalDatabas // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -14786,8 +14896,8 @@ func (c *Lightsail) StopInstanceRequest(input *StopInstanceInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -14894,8 +15004,8 @@ func (c *Lightsail) StopRelationalDatabaseRequest(input *StopRelationalDatabaseI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15005,8 +15115,8 @@ func (c *Lightsail) TagResourceRequest(input *TagResourceInput) (req *request.Re // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15117,8 +15227,8 @@ func (c *Lightsail) TestAlarmRequest(input *TestAlarmInput) (req *request.Reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * OperationFailureException // Lightsail throws this exception when an operation fails to execute. @@ -15217,8 +15327,8 @@ func (c *Lightsail) UnpeerVpcRequest(input *UnpeerVpcInput) (req *request.Reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15326,8 +15436,8 @@ func (c *Lightsail) UntagResourceRequest(input *UntagResourceInput) (req *reques // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15415,8 +15525,8 @@ func (c *Lightsail) UpdateBucketRequest(input *UpdateBucketInput) (req *request. // Updates an existing Amazon Lightsail bucket. // // Use this action to update the configuration of an existing bucket, such as -// versioning, public accessibility, and the AWS accounts that can access the -// bucket. +// versioning, public accessibility, and the Amazon Web Services accounts that +// can access the bucket. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -15435,8 +15545,8 @@ func (c *Lightsail) UpdateBucketRequest(input *UpdateBucketInput) (req *request. // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15548,8 +15658,8 @@ func (c *Lightsail) UpdateBucketBundleRequest(input *UpdateBucketBundleInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15645,8 +15755,8 @@ func (c *Lightsail) UpdateContainerServiceRequest(input *UpdateContainerServiceI // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15744,8 +15854,8 @@ func (c *Lightsail) UpdateDistributionRequest(input *UpdateDistributionInput) (r // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15857,8 +15967,8 @@ func (c *Lightsail) UpdateDistributionBundleRequest(input *UpdateDistributionBun // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -15961,8 +16071,8 @@ func (c *Lightsail) UpdateDomainEntryRequest(input *UpdateDomainEntryInput) (req // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -16070,8 +16180,8 @@ func (c *Lightsail) UpdateLoadBalancerAttributeRequest(input *UpdateLoadBalancer // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -16181,8 +16291,8 @@ func (c *Lightsail) UpdateRelationalDatabaseRequest(input *UpdateRelationalDatab // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -16296,8 +16406,8 @@ func (c *Lightsail) UpdateRelationalDatabaseParametersRequest(input *UpdateRelat // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. // // * NotFoundException // Lightsail throws this exception when it cannot find a resource. @@ -18155,8 +18265,8 @@ type Bucket struct { // Indicates whether the bundle that is currently applied to a bucket can be // changed to another bundle. // - // You can update a bucket's bundle only one time within a monthly AWS billing - // cycle. + // You can update a bucket's bundle only one time within a monthly Amazon Web + // Services billing cycle. // // Use the UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) // action to change a bucket's bundle. @@ -18183,7 +18293,8 @@ type Bucket struct { // The timestamp when the distribution was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // Describes the resource location. + // An object that describes the location of the bucket, such as the Amazon Web + // Services Region and Availability Zone. Location *ResourceLocation `locationName:"location" type:"structure"` // The name of the bucket. @@ -18201,8 +18312,8 @@ type Bucket struct { // * NeverEnabled - Object versioning has never been enabled. ObjectVersioning *string `locationName:"objectVersioning" type:"string"` - // An array of strings that specify the AWS account IDs that have read-only - // access to the bucket. + // An array of strings that specify the Amazon Web Services account IDs that + // have read-only access to the bucket. ReadonlyAccessAccounts []*string `locationName:"readonlyAccessAccounts" type:"list"` // The Lightsail resource type of the bucket (for example, Bucket). @@ -18356,8 +18467,8 @@ type BucketAccessLogConfig struct { _ struct{} `type:"structure"` // The name of the bucket where the access logs are saved. The destination can - // be a Lightsail bucket in the same account, and in the same AWS Region as - // the source bucket. + // be a Lightsail bucket in the same account, and in the same Amazon Web Services + // Region as the source bucket. // // This parameter is required when enabling the access log for a bucket, and // should be omitted when disabling the access log. @@ -19408,8 +19519,8 @@ type CloudFormationStackRecord struct { // and the Amazon Resource Name (ARN) of the AWS CloudFormation stack. DestinationInfo *DestinationInfo `locationName:"destinationInfo" type:"structure"` - // A list of objects describing the Availability Zone and AWS Region of the - // CloudFormation stack record. + // A list of objects describing the Availability Zone and Amazon Web Services + // Region of the CloudFormation stack record. Location *ResourceLocation `locationName:"location" type:"structure"` // The name of the CloudFormation stack record. It starts with CloudFormationStackRecord @@ -19560,7 +19671,8 @@ type ContactMethod struct { // The timestamp when the contact method was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // Describes the resource location. + // An object that describes the location of the contact method, such as the + // Amazon Web Services Region and Availability Zone. Location *ResourceLocation `locationName:"location" type:"structure"` // The name of the contact method. @@ -19808,7 +19920,7 @@ type ContainerService struct { IsDisabled *bool `locationName:"isDisabled" type:"boolean"` // An object that describes the location of the container service, such as the - // AWS Region and Availability Zone. + // Amazon Web Services Region and Availability Zone. Location *ResourceLocation `locationName:"location" type:"structure"` // An object that describes the next deployment of the container service. @@ -19828,9 +19940,9 @@ type ContainerService struct { // The principal ARN of the container service. // // The principal ARN can be used to create a trust relationship between your - // standard AWS account and your Lightsail container service. This allows you - // to give your service permission to access resources in your standard AWS - // account. + // standard Amazon Web Services account and your Lightsail container service. + // This allows you to give your service permission to access resources in your + // standard Amazon Web Services account. PrincipalArn *string `locationName:"principalArn" type:"string"` // The private domain name of the container service. @@ -20638,7 +20750,8 @@ type CopySnapshotInput struct { // (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots). RestoreDate *string `locationName:"restoreDate" type:"string"` - // The AWS Region where the source manual or automatic snapshot is located. + // The Amazon Web Services Region where the source manual or automatic snapshot + // is located. // // SourceRegion is a required field SourceRegion *string `locationName:"sourceRegion" type:"string" required:"true" enum:"RegionName"` @@ -21258,7 +21371,7 @@ type CreateContactMethodInput struct { // The protocol of the contact method, such as Email or SMS (text messaging). // - // The SMS protocol is supported only in the following AWS Regions. + // The SMS protocol is supported only in the following Amazon Web Services Regions. // // * US East (N. Virginia) (us-east-1) // @@ -21273,8 +21386,8 @@ type CreateContactMethodInput struct { // * Asia Pacific (Sydney) (ap-southeast-2) // // For a list of countries/regions where SMS text messages can be sent, and - // the latest AWS Regions where SMS text messaging is supported, see Supported - // Regions and Countries (https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html) + // the latest Amazon Web Services Regions where SMS text messaging is supported, + // see Supported Regions and Countries (https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html) // in the Amazon SNS Developer Guide. // // For more information about notifications in Amazon Lightsail, see Notifications @@ -21537,7 +21650,8 @@ type CreateContainerServiceInput struct { // // The following are the requirements for container service names: // - // * Must be unique within each AWS Region in your Lightsail account. + // * Must be unique within each Amazon Web Services Region in your Lightsail + // account. // // * Must contain 1 to 63 characters. // @@ -23330,6 +23444,16 @@ type CreateLoadBalancerInput struct { // // Use the TagResource action to tag a resource after it's created. Tags []*Tag `locationName:"tags" type:"list"` + + // The name of the TLS policy to apply to the load balancer. + // + // Use the GetLoadBalancerTlsPolicies (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html) + // action to get a list of TLS policy names that you can specify. + // + // For more information about load balancer TLS policies, see Load balancer + // TLS security policies (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) + // in the Amazon Lightsail Developer Guide. + TlsPolicyName *string `locationName:"tlsPolicyName" type:"string"` } // String returns the string representation. @@ -23417,6 +23541,12 @@ func (s *CreateLoadBalancerInput) SetTags(v []*Tag) *CreateLoadBalancerInput { return s } +// SetTlsPolicyName sets the TlsPolicyName field's value. +func (s *CreateLoadBalancerInput) SetTlsPolicyName(v string) *CreateLoadBalancerInput { + s.TlsPolicyName = &v + return s +} + type CreateLoadBalancerOutput struct { _ struct{} `type:"structure"` @@ -28580,8 +28710,8 @@ type GetBucketsInput struct { // The name of the bucket for which to return information. // - // When omitted, the response includes all of your buckets in the AWS Region - // where the request is made. + // When omitted, the response includes all of your buckets in the Amazon Web + // Services Region where the request is made. BucketName *string `locationName:"bucketName" min:"3" type:"string"` // A Boolean value that indicates whether to include Lightsail instances that @@ -28800,16 +28930,17 @@ type GetCertificatesInput struct { // The name for the certificate for which to return information. // - // When omitted, the response includes all of your certificates in the AWS Region - // where the request is made. + // When omitted, the response includes all of your certificates in the Amazon + // Web Services Region where the request is made. CertificateName *string `locationName:"certificateName" type:"string"` // The status of the certificates for which to return information. // // For example, specify ISSUED to return only certificates with an ISSUED status. // - // When omitted, the response includes all of your certificates in the AWS Region - // where the request is made, regardless of their current status. + // When omitted, the response includes all of your certificates in the Amazon + // Web Services Region where the request is made, regardless of their current + // status. CertificateStatuses []*string `locationName:"certificateStatuses" type:"list" enum:"CertificateStatus"` // Indicates whether to include detailed information about the certificates @@ -29695,7 +29826,7 @@ type GetContainerServicesInput struct { // The name of the container service for which to return information. // // When omitted, the response includes all of your container services in the - // AWS Region where the request is made. + // Amazon Web Services Region where the request is made. ServiceName *string `locationName:"serviceName" min:"1" type:"string"` } @@ -30471,8 +30602,8 @@ type GetDistributionsInput struct { // The name of the distribution for which to return information. // - // When omitted, the response includes all of your distributions in the AWS - // Region where the request is made. + // When omitted, the response includes all of your distributions in the Amazon + // Web Services Region where the request is made. DistributionName *string `locationName:"distributionName" type:"string"` // The token to advance to the next page of results from your request. @@ -32206,6 +32337,86 @@ func (s *GetLoadBalancerTlsCertificatesOutput) SetTlsCertificates(v []*LoadBalan return s } +type GetLoadBalancerTlsPoliciesInput struct { + _ struct{} `type:"structure"` + + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetLoadBalancerTlsPolicies request. + // If your results are paginated, the response will return a next page token + // that you can specify as the page token in a subsequent request. + PageToken *string `locationName:"pageToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetLoadBalancerTlsPoliciesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetLoadBalancerTlsPoliciesInput) GoString() string { + return s.String() +} + +// SetPageToken sets the PageToken field's value. +func (s *GetLoadBalancerTlsPoliciesInput) SetPageToken(v string) *GetLoadBalancerTlsPoliciesInput { + s.PageToken = &v + return s +} + +type GetLoadBalancerTlsPoliciesOutput struct { + _ struct{} `type:"structure"` + + // The token to advance to the next page of results from your request. + // + // A next page token is not returned if there are no more results to display. + // + // To get the next page of results, perform another GetLoadBalancerTlsPolicies + // request and specify the next page token using the pageToken parameter. + NextPageToken *string `locationName:"nextPageToken" type:"string"` + + // An array of objects that describe the TLS security policies that are available. + TlsPolicies []*LoadBalancerTlsPolicy `locationName:"tlsPolicies" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetLoadBalancerTlsPoliciesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetLoadBalancerTlsPoliciesOutput) GoString() string { + return s.String() +} + +// SetNextPageToken sets the NextPageToken field's value. +func (s *GetLoadBalancerTlsPoliciesOutput) SetNextPageToken(v string) *GetLoadBalancerTlsPoliciesOutput { + s.NextPageToken = &v + return s +} + +// SetTlsPolicies sets the TlsPolicies field's value. +func (s *GetLoadBalancerTlsPoliciesOutput) SetTlsPolicies(v []*LoadBalancerTlsPolicy) *GetLoadBalancerTlsPoliciesOutput { + s.TlsPolicies = v + return s +} + type GetLoadBalancersInput struct { _ struct{} `type:"structure"` @@ -35714,8 +35925,8 @@ func (s *InstanceState) SetName(v string) *InstanceState { // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) -// AWS Region. Please set your AWS Region configuration to us-east-1 to create, -// view, or edit these resources. +// Amazon Web Services Region. Please set your Amazon Web Services Region configuration +// to us-east-1 to create, view, or edit these resources. type InvalidInputException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -35982,12 +36193,12 @@ type LightsailDistribution struct { // Indicates whether the distribution is enabled. IsEnabled *bool `locationName:"isEnabled" type:"boolean"` - // An object that describes the location of the distribution, such as the AWS - // Region and Availability Zone. + // An object that describes the location of the distribution, such as the Amazon + // Web Services Region and Availability Zone. // // Lightsail distributions are global resources that can reference an origin - // in any AWS Region, and distribute its content globally. However, all distributions - // are located in the us-east-1 Region. + // in any Amazon Web Services Region, and distribute its content globally. However, + // all distributions are located in the us-east-1 Region. Location *ResourceLocation `locationName:"location" type:"structure"` // The name of the distribution. @@ -36177,6 +36388,10 @@ type LoadBalancer struct { // the load balancer tries to make a request to the default (root) page. HealthCheckPath *string `locationName:"healthCheckPath" type:"string"` + // A Boolean value that indicates whether HTTPS redirection is enabled for the + // load balancer. + HttpsRedirectionEnabled *bool `locationName:"httpsRedirectionEnabled" type:"boolean"` + // An array of InstanceHealthSummary objects describing the health of the load // balancer. InstanceHealthSummary []*InstanceHealthSummary `locationName:"instanceHealthSummary" type:"list"` @@ -36225,6 +36440,15 @@ type LoadBalancer struct { // information about the SSL/TLS certificates. For example, if true, the certificate // is attached to the load balancer. TlsCertificateSummaries []*LoadBalancerTlsCertificateSummary `locationName:"tlsCertificateSummaries" type:"list"` + + // The name of the TLS security policy for the load balancer. + // + // The following TLS security policy names are possible: + // + // * TLS-2016-08 + // + // * TLS-FS-Res-1-2-2019-08 + TlsPolicyName *string `locationName:"tlsPolicyName" type:"string"` } // String returns the string representation. @@ -36275,6 +36499,12 @@ func (s *LoadBalancer) SetHealthCheckPath(v string) *LoadBalancer { return s } +// SetHttpsRedirectionEnabled sets the HttpsRedirectionEnabled field's value. +func (s *LoadBalancer) SetHttpsRedirectionEnabled(v bool) *LoadBalancer { + s.HttpsRedirectionEnabled = &v + return s +} + // SetInstanceHealthSummary sets the InstanceHealthSummary field's value. func (s *LoadBalancer) SetInstanceHealthSummary(v []*InstanceHealthSummary) *LoadBalancer { s.InstanceHealthSummary = v @@ -36347,6 +36577,12 @@ func (s *LoadBalancer) SetTlsCertificateSummaries(v []*LoadBalancerTlsCertificat return s } +// SetTlsPolicyName sets the TlsPolicyName field's value. +func (s *LoadBalancer) SetTlsPolicyName(v string) *LoadBalancer { + s.TlsPolicyName = &v + return s +} + // Describes a load balancer SSL/TLS certificate. // // TLS is just an updated, more secure version of Secure Socket Layer (SSL). @@ -36901,6 +37137,101 @@ func (s *LoadBalancerTlsCertificateSummary) SetName(v string) *LoadBalancerTlsCe return s } +// Describes the TLS security policies that are available for Lightsail load +// balancers. +// +// For more information about load balancer TLS security policies, see Load +// balancer TLS security policies (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) +// in the Amazon Lightsail Developer Guide. +type LoadBalancerTlsPolicy struct { + _ struct{} `type:"structure"` + + // The ciphers used by the TLS security policy. + // + // The ciphers are listed in order of preference. + Ciphers []*string `locationName:"ciphers" type:"list"` + + // The description of the TLS security policy. + Description *string `locationName:"description" type:"string"` + + // A Boolean value that indicates whether the TLS security policy is the default. + IsDefault *bool `locationName:"isDefault" type:"boolean"` + + // The name of the TLS security policy. + // + // The following TLS security policy names are possible: + // + // * TLS-2016-08 + // + // * TLS-FS-Res-1-2-2019-08 + // + // You can specify either of these values for the tlsSecurityPolicyName request + // parameter in the CreateLoadBalancer (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateLoadBalancer.html) + // action, and the attributeValue request parameter in the UpdateLoadBalancerAttribute + // (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateLoadBalancerAttribute.html) + // action. + Name *string `locationName:"name" type:"string"` + + // The protocols used in a given TLS security policy. + // + // The following protocols are possible: + // + // * Protocol-TLSv1 + // + // * Protocol-TLSv1.1 + // + // * Protocol-TLSv1.2 + Protocols []*string `locationName:"protocols" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoadBalancerTlsPolicy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoadBalancerTlsPolicy) GoString() string { + return s.String() +} + +// SetCiphers sets the Ciphers field's value. +func (s *LoadBalancerTlsPolicy) SetCiphers(v []*string) *LoadBalancerTlsPolicy { + s.Ciphers = v + return s +} + +// SetDescription sets the Description field's value. +func (s *LoadBalancerTlsPolicy) SetDescription(v string) *LoadBalancerTlsPolicy { + s.Description = &v + return s +} + +// SetIsDefault sets the IsDefault field's value. +func (s *LoadBalancerTlsPolicy) SetIsDefault(v bool) *LoadBalancerTlsPolicy { + s.IsDefault = &v + return s +} + +// SetName sets the Name field's value. +func (s *LoadBalancerTlsPolicy) SetName(v string) *LoadBalancerTlsPolicy { + s.Name = &v + return s +} + +// SetProtocols sets the Protocols field's value. +func (s *LoadBalancerTlsPolicy) SetProtocols(v []*string) *LoadBalancerTlsPolicy { + s.Protocols = v + return s +} + // Describes a database log event. type LogEvent struct { _ struct{} `type:"structure"` @@ -37304,7 +37635,7 @@ type Operation struct { // A Boolean value indicating whether the operation is terminal. IsTerminal *bool `locationName:"isTerminal" type:"boolean"` - // The AWS Region and Availability Zone. + // The Amazon Web Services Region and Availability Zone. Location *ResourceLocation `locationName:"location" type:"structure"` // Details about the operation (e.g., Debian-1GB-Ohio-1). @@ -37962,11 +38293,12 @@ type PutAlarmInput struct { // are enabled for the alarm, and when the alarm is triggered. // // A notification is not sent if a contact protocol is not specified, if the - // specified contact protocol is not configured in the AWS Region, or if notifications - // are not enabled for the alarm using the notificationEnabled paramater. + // specified contact protocol is not configured in the Amazon Web Services Region, + // or if notifications are not enabled for the alarm using the notificationEnabled + // paramater. // // Use the CreateContactMethod action to configure a contact protocol in an - // AWS Region. + // Amazon Web Services Region. ContactProtocols []*string `locationName:"contactProtocols" type:"list" enum:"ContactProtocol"` // The number of data points that must be not within the specified threshold @@ -38718,8 +39050,8 @@ func (s *RegisterContainerImageInput) SetServiceName(v string) *RegisterContaine type RegisterContainerImageOutput struct { _ struct{} `type:"structure"` - // Describes a container image that is registered to an Amazon Lightsail container - // service. + // An object that describes a container image that is registered to a Lightsail + // container service ContainerImage *ContainerImage `locationName:"containerImage" type:"structure"` } @@ -40157,8 +40489,8 @@ type SetIpAddressTypeInput struct { // The possible values are Distribution, Instance, and LoadBalancer. // // Distribution-related APIs are available only in the N. Virginia (us-east-1) - // AWS Region. Set your AWS Region configuration to us-east-1 to create, view, - // or edit distributions. + // Amazon Web Services Region. Set your Amazon Web Services Region configuration + // to us-east-1 to create, view, or edit distributions. // // ResourceType is a required field ResourceType *string `locationName:"resourceType" type:"string" required:"true" enum:"ResourceType"` @@ -41414,9 +41746,10 @@ type UpdateBucketInput struct { // BucketName is a required field BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"` - // An array of strings to specify the AWS account IDs that can access the bucket. + // An array of strings to specify the Amazon Web Services account IDs that can + // access the bucket. // - // You can give a maximum of 10 AWS accounts access to a bucket. + // You can give a maximum of 10 Amazon Web Services accounts access to a bucket. ReadonlyAccessAccounts []*string `locationName:"readonlyAccessAccounts" type:"list"` // Specifies whether to enable or suspend versioning of objects in the bucket. @@ -41739,7 +42072,9 @@ func (s *UpdateDistributionBundleInput) SetDistributionName(v string) *UpdateDis type UpdateDistributionBundleOutput struct { _ struct{} `type:"structure"` - // Describes the API operation. + // An object that describes the result of the action, such as the status of + // the request, the timestamp of the request, and the resources affected by + // the request. Operation *Operation `locationName:"operation" type:"structure"` } @@ -41996,13 +42331,34 @@ func (s *UpdateDomainEntryOutput) SetOperations(v []*Operation) *UpdateDomainEnt type UpdateLoadBalancerAttributeInput struct { _ struct{} `type:"structure"` - // The name of the attribute you want to update. Valid values are below. + // The name of the attribute you want to update. // // AttributeName is a required field AttributeName *string `locationName:"attributeName" type:"string" required:"true" enum:"LoadBalancerAttributeName"` // The value that you want to specify for the attribute name. // + // The following values are supported depending on what you specify for the + // attributeName request parameter: + // + // * If you specify HealthCheckPath for the attributeName request parameter, + // then the attributeValue request parameter must be the path to ping on + // the target (for example, /weather/us/wa/seattle). + // + // * If you specify SessionStickinessEnabled for the attributeName request + // parameter, then the attributeValue request parameter must be true or false. + // + // * If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName + // request parameter, then the attributeValue request parameter must be an + // interger that represents the cookie duration in seconds. + // + // * If you specify HttpsRedirectionEnabled for the attributeName request + // parameter, then the attributeValue request parameter must be true or false. + // + // * If you specify TlsPolicyName for the attributeName request parameter, + // then the attributeValue request parameter must be TLS version 1.0, 1.1, + // and 1.2 or TLS version 1.2. + // // AttributeValue is a required field AttributeValue *string `locationName:"attributeValue" min:"1" type:"string" required:"true"` @@ -43284,6 +43640,12 @@ const ( // LoadBalancerAttributeNameSessionStickinessLbCookieDurationSeconds is a LoadBalancerAttributeName enum value LoadBalancerAttributeNameSessionStickinessLbCookieDurationSeconds = "SessionStickiness_LB_CookieDurationSeconds" + + // LoadBalancerAttributeNameHttpsRedirectionEnabled is a LoadBalancerAttributeName enum value + LoadBalancerAttributeNameHttpsRedirectionEnabled = "HttpsRedirectionEnabled" + + // LoadBalancerAttributeNameTlsPolicyName is a LoadBalancerAttributeName enum value + LoadBalancerAttributeNameTlsPolicyName = "TlsPolicyName" ) // LoadBalancerAttributeName_Values returns all elements of the LoadBalancerAttributeName enum @@ -43292,6 +43654,8 @@ func LoadBalancerAttributeName_Values() []string { LoadBalancerAttributeNameHealthCheckPath, LoadBalancerAttributeNameSessionStickinessEnabled, LoadBalancerAttributeNameSessionStickinessLbCookieDurationSeconds, + LoadBalancerAttributeNameHttpsRedirectionEnabled, + LoadBalancerAttributeNameTlsPolicyName, } } diff --git a/service/lightsail/doc.go b/service/lightsail/doc.go index 73c35ed0a6e..bc222b337da 100644 --- a/service/lightsail/doc.go +++ b/service/lightsail/doc.go @@ -4,12 +4,12 @@ // requests to Amazon Lightsail. // // Amazon Lightsail is the easiest way to get started with Amazon Web Services -// (AWS) for developers who need to build websites or web applications. It includes -// everything you need to launch your project quickly - instances (virtual private -// servers), container services, storage buckets, managed databases, SSD-based -// block storage, static IP addresses, load balancers, content delivery network -// (CDN) distributions, DNS management of registered domains, and resource snapshots -// (backups) - for a low, predictable monthly price. +// (Amazon Web Services) for developers who need to build websites or web applications. +// It includes everything you need to launch your project quickly - instances +// (virtual private servers), container services, storage buckets, managed databases, +// SSD-based block storage, static IP addresses, load balancers, content delivery +// network (CDN) distributions, DNS management of registered domains, and resource +// snapshots (backups) - for a low, predictable monthly price. // // You can manage your Lightsail resources using the Lightsail console, Lightsail // API, AWS Command Line Interface (AWS CLI), or SDKs. For more information @@ -18,9 +18,9 @@ // // This API Reference provides detailed information about the actions, data // types, parameters, and errors of the Lightsail service. For more information -// about the supported AWS Regions, endpoints, and service quotas of the Lightsail -// service, see Amazon Lightsail Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) -// in the AWS General Reference. +// about the supported Amazon Web Services Regions, endpoints, and service quotas +// of the Lightsail service, see Amazon Lightsail Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) +// in the Amazon Web Services General Reference. // // See https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28 for more information on this service. // diff --git a/service/lightsail/errors.go b/service/lightsail/errors.go index f390e9f5646..05162989216 100644 --- a/service/lightsail/errors.go +++ b/service/lightsail/errors.go @@ -29,8 +29,8 @@ const ( // rules of an input field. // // Domain and distribution APIs are only available in the N. Virginia (us-east-1) - // AWS Region. Please set your AWS Region configuration to us-east-1 to create, - // view, or edit these resources. + // Amazon Web Services Region. Please set your Amazon Web Services Region configuration + // to us-east-1 to create, view, or edit these resources. ErrCodeInvalidInputException = "InvalidInputException" // ErrCodeNotFoundException for service response error code diff --git a/service/lightsail/lightsailiface/interface.go b/service/lightsail/lightsailiface/interface.go index 478042d98b7..4d2ac316bab 100644 --- a/service/lightsail/lightsailiface/interface.go +++ b/service/lightsail/lightsailiface/interface.go @@ -472,6 +472,10 @@ type LightsailAPI interface { GetLoadBalancerTlsCertificatesWithContext(aws.Context, *lightsail.GetLoadBalancerTlsCertificatesInput, ...request.Option) (*lightsail.GetLoadBalancerTlsCertificatesOutput, error) GetLoadBalancerTlsCertificatesRequest(*lightsail.GetLoadBalancerTlsCertificatesInput) (*request.Request, *lightsail.GetLoadBalancerTlsCertificatesOutput) + GetLoadBalancerTlsPolicies(*lightsail.GetLoadBalancerTlsPoliciesInput) (*lightsail.GetLoadBalancerTlsPoliciesOutput, error) + GetLoadBalancerTlsPoliciesWithContext(aws.Context, *lightsail.GetLoadBalancerTlsPoliciesInput, ...request.Option) (*lightsail.GetLoadBalancerTlsPoliciesOutput, error) + GetLoadBalancerTlsPoliciesRequest(*lightsail.GetLoadBalancerTlsPoliciesInput) (*request.Request, *lightsail.GetLoadBalancerTlsPoliciesOutput) + GetLoadBalancers(*lightsail.GetLoadBalancersInput) (*lightsail.GetLoadBalancersOutput, error) GetLoadBalancersWithContext(aws.Context, *lightsail.GetLoadBalancersInput, ...request.Option) (*lightsail.GetLoadBalancersOutput, error) GetLoadBalancersRequest(*lightsail.GetLoadBalancersInput) (*request.Request, *lightsail.GetLoadBalancersOutput) diff --git a/service/networkfirewall/api.go b/service/networkfirewall/api.go index 23961381374..8a384ae1bd7 100644 --- a/service/networkfirewall/api.go +++ b/service/networkfirewall/api.go @@ -168,9 +168,9 @@ func (c *NetworkFirewall) AssociateSubnetsRequest(input *AssociateSubnetsInput) // Associates the specified subnets in the Amazon VPC to the firewall. You can // specify one subnet for each of the Availability Zones that the VPC spans. // -// This request creates an AWS Network Firewall firewall endpoint in each of -// the subnets. To enable the firewall's protections, you must also modify the -// VPC's route tables for each subnet's Availability Zone, to redirect the traffic +// This request creates an Network Firewall firewall endpoint in each of the +// subnets. To enable the firewall's protections, you must also modify the VPC's +// route tables for each subnet's Availability Zone, to redirect the traffic // that's coming into and going out of the zone through the firewall endpoint. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -210,8 +210,8 @@ func (c *NetworkFirewall) AssociateSubnetsRequest(input *AssociateSubnetsInput) // tried to delete a rule group or firewall policy that's in use. // // * InsufficientCapacityException -// AWS doesn't currently have enough available capacity to fulfill your request. -// Try your request later. +// Amazon Web Services doesn't currently have enough available capacity to fulfill +// your request. Try your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/AssociateSubnets func (c *NetworkFirewall) AssociateSubnets(input *AssociateSubnetsInput) (*AssociateSubnetsOutput, error) { @@ -279,13 +279,13 @@ func (c *NetworkFirewall) CreateFirewallRequest(input *CreateFirewallInput) (req // CreateFirewall API operation for AWS Network Firewall. // -// Creates an AWS Network Firewall Firewall and accompanying FirewallStatus -// for a VPC. +// Creates an Network Firewall Firewall and accompanying FirewallStatus for +// a VPC. // -// The firewall defines the configuration settings for an AWS Network Firewall -// firewall. The settings that you can define at creation include the firewall -// policy, the subnets in your VPC to use for the firewall endpoints, and any -// tags that are attached to the firewall AWS resource. +// The firewall defines the configuration settings for an Network Firewall firewall. +// The settings that you can define at creation include the firewall policy, +// the subnets in your VPC to use for the firewall endpoints, and any tags that +// are attached to the firewall Amazon Web Services resource. // // After you create a firewall, you can provide additional settings, like the // logging configuration. @@ -294,8 +294,8 @@ func (c *NetworkFirewall) CreateFirewallRequest(input *CreateFirewallInput) (req // to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, // and UpdateFirewallDeleteProtection. // -// To manage a firewall's tags, use the standard AWS resource tagging operations, -// ListTagsForResource, TagResource, and UntagResource. +// To manage a firewall's tags, use the standard Amazon Web Services resource +// tagging operations, ListTagsForResource, TagResource, and UntagResource. // // To retrieve information about firewalls, use ListFirewalls and DescribeFirewall. // @@ -329,8 +329,8 @@ func (c *NetworkFirewall) CreateFirewallRequest(input *CreateFirewallInput) (req // Unable to process the request due to throttling limitations. // // * InsufficientCapacityException -// AWS doesn't currently have enough available capacity to fulfill your request. -// Try your request later. +// Amazon Web Services doesn't currently have enough available capacity to fulfill +// your request. Try your request later. // // * InvalidOperationException // The operation failed because it's not valid. For example, you might have @@ -404,9 +404,9 @@ func (c *NetworkFirewall) CreateFirewallPolicyRequest(input *CreateFirewallPolic // // Creates the firewall policy for the firewall according to the specifications. // -// An AWS Network Firewall firewall policy defines the behavior of a firewall, -// in a collection of stateless and stateful rule groups and other settings. -// You can use one firewall policy for multiple firewalls. +// An Network Firewall firewall policy defines the behavior of a firewall, in +// a collection of stateless and stateful rule groups and other settings. You +// can use one firewall policy for multiple firewalls. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -438,8 +438,8 @@ func (c *NetworkFirewall) CreateFirewallPolicyRequest(input *CreateFirewallPolic // because of a system problem. Retry your request. // // * InsufficientCapacityException -// AWS doesn't currently have enough available capacity to fulfill your request. -// Try your request later. +// Amazon Web Services doesn't currently have enough available capacity to fulfill +// your request. Try your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateFirewallPolicy func (c *NetworkFirewall) CreateFirewallPolicy(input *CreateFirewallPolicyInput) (*CreateFirewallPolicyOutput, error) { @@ -543,8 +543,8 @@ func (c *NetworkFirewall) CreateRuleGroupRequest(input *CreateRuleGroupInput) (r // because of a system problem. Retry your request. // // * InsufficientCapacityException -// AWS doesn't currently have enough available capacity to fulfill your request. -// Try your request later. +// Amazon Web Services doesn't currently have enough available capacity to fulfill +// your request. Try your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateRuleGroup func (c *NetworkFirewall) CreateRuleGroup(input *CreateRuleGroupInput) (*CreateRuleGroupOutput, error) { @@ -2202,10 +2202,10 @@ func (c *NetworkFirewall) ListTagsForResourceRequest(input *ListTagsForResourceI // pairs that you can use to categorize and manage your resources, for purposes // like billing. For example, you might set the tag key to "customer" and the // value to the customer name or ID. You can specify one or more tags to add -// to each AWS resource, up to 50 tags for a resource. +// to each Amazon Web Services resource, up to 50 tags for a resource. // -// You can tag the AWS resources that you manage through AWS Network Firewall: -// firewalls, firewall policies, and rule groups. +// You can tag the Amazon Web Services resources that you manage through Network +// Firewall: firewalls, firewall policies, and rule groups. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2355,11 +2355,10 @@ func (c *NetworkFirewall) PutResourcePolicyRequest(input *PutResourcePolicyInput // PutResourcePolicy API operation for AWS Network Firewall. // -// Creates or updates an AWS Identity and Access Management policy for your -// rule group or firewall policy. Use this to share rule groups and firewall -// policies between accounts. This operation works in conjunction with the AWS -// Resource Access Manager (RAM) service to manage resource sharing for Network -// Firewall. +// Creates or updates an IAM policy for your rule group or firewall policy. +// Use this to share rule groups and firewall policies between accounts. This +// operation works in conjunction with the Amazon Web Services Resource Access +// Manager (RAM) service to manage resource sharing for Network Firewall. // // Use this operation to create or update a resource policy for your rule group // or firewall policy. In the policy, you specify the accounts that you want @@ -2376,7 +2375,7 @@ func (c *NetworkFirewall) PutResourcePolicyRequest(input *PutResourcePolicyInput // * AcceptResourceShareInvitation (https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html) // - Accepts the share invitation for a specified resource share. // -// For additional information about resource sharing using RAM, see AWS Resource +// For additional information about resource sharing using RAM, see Resource // Access Manager User Guide (https://docs.aws.amazon.com/ram/latest/userguide/what-is.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2482,10 +2481,10 @@ func (c *NetworkFirewall) TagResourceRequest(input *TagResourceInput) (req *requ // that you can use to categorize and manage your resources, for purposes like // billing. For example, you might set the tag key to "customer" and the value // to the customer name or ID. You can specify one or more tags to add to each -// AWS resource, up to 50 tags for a resource. +// Amazon Web Services resource, up to 50 tags for a resource. // -// You can tag the AWS resources that you manage through AWS Network Firewall: -// firewalls, firewall policies, and rule groups. +// You can tag the Amazon Web Services resources that you manage through Network +// Firewall: firewalls, firewall policies, and rule groups. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2587,10 +2586,10 @@ func (c *NetworkFirewall) UntagResourceRequest(input *UntagResourceInput) (req * // are key:value pairs that you can use to categorize and manage your resources, // for purposes like billing. For example, you might set the tag key to "customer" // and the value to the customer name or ID. You can specify one or more tags -// to add to each AWS resource, up to 50 tags for a resource. +// to add to each Amazon Web Services resource, up to 50 tags for a resource. // -// You can manage tags for the AWS resources that you manage through AWS Network -// Firewall: firewalls, firewall policies, and rule groups. +// You can manage tags for the Amazon Web Services resources that you manage +// through Network Firewall: firewalls, firewall policies, and rule groups. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2850,6 +2849,109 @@ func (c *NetworkFirewall) UpdateFirewallDescriptionWithContext(ctx aws.Context, return out, req.Send() } +const opUpdateFirewallEncryptionConfiguration = "UpdateFirewallEncryptionConfiguration" + +// UpdateFirewallEncryptionConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the UpdateFirewallEncryptionConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateFirewallEncryptionConfiguration for more information on using the UpdateFirewallEncryptionConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateFirewallEncryptionConfigurationRequest method. +// req, resp := client.UpdateFirewallEncryptionConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration +func (c *NetworkFirewall) UpdateFirewallEncryptionConfigurationRequest(input *UpdateFirewallEncryptionConfigurationInput) (req *request.Request, output *UpdateFirewallEncryptionConfigurationOutput) { + op := &request.Operation{ + Name: opUpdateFirewallEncryptionConfiguration, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateFirewallEncryptionConfigurationInput{} + } + + output = &UpdateFirewallEncryptionConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateFirewallEncryptionConfiguration API operation for AWS Network Firewall. +// +// A complex type that contains settings for encryption of your firewall resources. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Network Firewall's +// API operation UpdateFirewallEncryptionConfiguration for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The operation failed because of a problem with your request. Examples include: +// +// * You specified an unsupported parameter name or value. +// +// * You tried to update a property with a value that isn't among the available +// types. +// +// * Your request references an ARN that is malformed, or corresponds to +// a resource that isn't valid in the context of the request. +// +// * InternalServerError +// Your request is valid, but Network Firewall couldn’t perform the operation +// because of a system problem. Retry your request. +// +// * ResourceNotFoundException +// Unable to locate a resource using the parameters that you provided. +// +// * ThrottlingException +// Unable to process the request due to throttling limitations. +// +// * InvalidTokenException +// The token you provided is stale or isn't valid for the operation. +// +// * ResourceOwnerCheckException +// Unable to change the resource because your account doesn't own it. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration +func (c *NetworkFirewall) UpdateFirewallEncryptionConfiguration(input *UpdateFirewallEncryptionConfigurationInput) (*UpdateFirewallEncryptionConfigurationOutput, error) { + req, out := c.UpdateFirewallEncryptionConfigurationRequest(input) + return out, req.Send() +} + +// UpdateFirewallEncryptionConfigurationWithContext is the same as UpdateFirewallEncryptionConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateFirewallEncryptionConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *NetworkFirewall) UpdateFirewallEncryptionConfigurationWithContext(ctx aws.Context, input *UpdateFirewallEncryptionConfigurationInput, opts ...request.Option) (*UpdateFirewallEncryptionConfigurationOutput, error) { + req, out := c.UpdateFirewallEncryptionConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateFirewallPolicy = "UpdateFirewallPolicy" // UpdateFirewallPolicyRequest generates a "aws/request.Request" representing the @@ -3865,7 +3967,7 @@ func (s *AssociateSubnetsOutput) SetUpdateToken(v string) *AssociateSubnetsOutpu } // The configuration and status for a single subnet that you've specified for -// use by the AWS Network Firewall firewall. This is part of the FirewallStatus. +// use by the Network Firewall firewall. This is part of the FirewallStatus. type Attachment struct { _ struct{} `type:"structure"` @@ -3935,6 +4037,9 @@ type CreateFirewallInput struct { // A description of the firewall. Description *string `type:"string"` + // A complex type that contains settings for encryption of your firewall resources. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + // The descriptive name of the firewall. You can't change the name of a firewall // after you create it. // @@ -4023,6 +4128,11 @@ func (s *CreateFirewallInput) Validate() error { if s.VpcId != nil && len(*s.VpcId) < 1 { invalidParams.Add(request.NewErrParamMinLen("VpcId", 1)) } + if s.EncryptionConfiguration != nil { + if err := s.EncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfiguration", err.(request.ErrInvalidParams)) + } + } if s.SubnetMappings != nil { for i, v := range s.SubnetMappings { if v == nil { @@ -4062,6 +4172,12 @@ func (s *CreateFirewallInput) SetDescription(v string) *CreateFirewallInput { return s } +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *CreateFirewallInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *CreateFirewallInput { + s.EncryptionConfiguration = v + return s +} + // SetFirewallName sets the FirewallName field's value. func (s *CreateFirewallInput) SetFirewallName(v string) *CreateFirewallInput { s.FirewallName = &v @@ -4166,6 +4282,10 @@ type CreateFirewallPolicyInput struct { // If set to FALSE, Network Firewall makes the requested changes to your resources. DryRun *bool `type:"boolean"` + // A complex type that contains settings for encryption of your firewall policy + // resources. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + // The rule groups and policy actions to use in the firewall policy. // // FirewallPolicy is a required field @@ -4214,6 +4334,11 @@ func (s *CreateFirewallPolicyInput) Validate() error { if s.Tags != nil && len(s.Tags) < 1 { invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) } + if s.EncryptionConfiguration != nil { + if err := s.EncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfiguration", err.(request.ErrInvalidParams)) + } + } if s.FirewallPolicy != nil { if err := s.FirewallPolicy.Validate(); err != nil { invalidParams.AddNested("FirewallPolicy", err.(request.ErrInvalidParams)) @@ -4248,6 +4373,12 @@ func (s *CreateFirewallPolicyInput) SetDryRun(v bool) *CreateFirewallPolicyInput return s } +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *CreateFirewallPolicyInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *CreateFirewallPolicyInput { + s.EncryptionConfiguration = v + return s +} + // SetFirewallPolicy sets the FirewallPolicy field's value. func (s *CreateFirewallPolicyInput) SetFirewallPolicy(v *FirewallPolicy) *CreateFirewallPolicyInput { s.FirewallPolicy = v @@ -4384,6 +4515,9 @@ type CreateRuleGroupInput struct { // If set to FALSE, Network Firewall makes the requested changes to your resources. DryRun *bool `type:"boolean"` + // A complex type that contains settings for encryption of your rule group resources. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + // An object that defines the rule group rules. // // You must provide either this rule group setting or a Rules setting, but not @@ -4456,6 +4590,11 @@ func (s *CreateRuleGroupInput) Validate() error { if s.Type == nil { invalidParams.Add(request.NewErrParamRequired("Type")) } + if s.EncryptionConfiguration != nil { + if err := s.EncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfiguration", err.(request.ErrInvalidParams)) + } + } if s.RuleGroup != nil { if err := s.RuleGroup.Validate(); err != nil { invalidParams.AddNested("RuleGroup", err.(request.ErrInvalidParams)) @@ -4496,6 +4635,12 @@ func (s *CreateRuleGroupInput) SetDryRun(v bool) *CreateRuleGroupInput { return s } +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *CreateRuleGroupInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *CreateRuleGroupInput { + s.EncryptionConfiguration = v + return s +} + // SetRuleGroup sets the RuleGroup field's value. func (s *CreateRuleGroupInput) SetRuleGroup(v *RuleGroup) *CreateRuleGroupInput { s.RuleGroup = v @@ -4732,10 +4877,10 @@ func (s *DeleteFirewallInput) SetFirewallName(v string) *DeleteFirewallInput { type DeleteFirewallOutput struct { _ struct{} `type:"structure"` - // The firewall defines the configuration settings for an AWS Network Firewall - // firewall. These settings include the firewall policy, the subnets in your - // VPC to use for the firewall endpoints, and any tags that are attached to - // the firewall AWS resource. + // The firewall defines the configuration settings for an Network Firewall firewall. + // These settings include the firewall policy, the subnets in your VPC to use + // for the firewall endpoints, and any tags that are attached to the firewall + // Amazon Web Services resource. // // The status of the firewall, for example whether it's ready to filter network // traffic, is provided in the corresponding FirewallStatus. You can retrieve @@ -5372,7 +5517,7 @@ type DescribeLoggingConfigurationOutput struct { // The Amazon Resource Name (ARN) of the firewall. FirewallArn *string `min:"1" type:"string"` - // Defines how AWS Network Firewall performs logging for a Firewall. + // Defines how Network Firewall performs logging for a Firewall. LoggingConfiguration *LoggingConfiguration `type:"structure"` } @@ -5459,7 +5604,7 @@ func (s *DescribeResourcePolicyInput) SetResourceArn(v string) *DescribeResource type DescribeResourcePolicyOutput struct { _ struct{} `type:"structure"` - // The AWS Identity and Access Management policy for the resource. + // The IAM policy for the resource. Policy *string `min:"1" type:"string"` } @@ -5740,7 +5885,7 @@ type DescribeRuleGroupOutput struct { // define the rule group. You can retrieve all objects for a rule group by calling // DescribeRuleGroup. // - // AWS Network Firewall uses a rule group to inspect and control network traffic. + // Network Firewall uses a rule group to inspect and control network traffic. // You define stateless rule groups to inspect individual packets and you define // stateful rule groups to inspect packets in the context of their traffic flow. // @@ -5812,7 +5957,7 @@ func (s *DescribeRuleGroupOutput) SetUpdateToken(v string) *DescribeRuleGroupOut // used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension // is a name/value pair that's part of the identity of a metric. // -// AWS Network Firewall sets the dimension name to CustomAction and you provide +// Network Firewall sets the dimension name to CustomAction and you provide // the dimension value. // // For more information about CloudWatch custom metric dimensions, see Publishing @@ -6039,10 +6184,77 @@ func (s *DisassociateSubnetsOutput) SetUpdateToken(v string) *DisassociateSubnet return s } -// The firewall defines the configuration settings for an AWS Network Firewall -// firewall. These settings include the firewall policy, the subnets in your -// VPC to use for the firewall endpoints, and any tags that are attached to -// the firewall AWS resource. +// A complex type that contains optional Amazon Web Services Key Management +// Service (KMS) encryption settings for your Network Firewall resources. Your +// data is encrypted by default with an Amazon Web Services owned key that Amazon +// Web Services owns and manages for you. You can use either the Amazon Web +// Services owned key, or provide your own customer managed key. To learn more +// about KMS encryption of your Network Firewall resources, see Encryption at +// rest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) +// in the Network Firewall Developer Guide. +type EncryptionConfiguration struct { + _ struct{} `type:"structure"` + + // The ID of the Amazon Web Services Key Management Service (KMS) customer managed + // key. You can use any of the key identifiers that KMS supports, unless you're + // using a key that's managed by another account. If you're using a key managed + // by another account, then specify the key ARN. For more information, see Key + // ID (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) + // in the Amazon Web Services KMS Developer Guide. + KeyId *string `min:"1" type:"string"` + + // The type of Amazon Web Services KMS key to use for encryption of your Network + // Firewall resources. + Type *string `type:"string" enum:"EncryptionType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EncryptionConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EncryptionConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EncryptionConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EncryptionConfiguration"} + if s.KeyId != nil && len(*s.KeyId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KeyId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKeyId sets the KeyId field's value. +func (s *EncryptionConfiguration) SetKeyId(v string) *EncryptionConfiguration { + s.KeyId = &v + return s +} + +// SetType sets the Type field's value. +func (s *EncryptionConfiguration) SetType(v string) *EncryptionConfiguration { + s.Type = &v + return s +} + +// The firewall defines the configuration settings for an Network Firewall firewall. +// These settings include the firewall policy, the subnets in your VPC to use +// for the firewall endpoints, and any tags that are attached to the firewall +// Amazon Web Services resource. // // The status of the firewall, for example whether it's ready to filter network // traffic, is provided in the corresponding FirewallStatus. You can retrieve @@ -6059,6 +6271,10 @@ type Firewall struct { // A description of the firewall. Description *string `type:"string"` + // A complex type that contains the Amazon Web Services KMS encryption configuration + // settings for your firewall. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + // The Amazon Resource Name (ARN) of the firewall. FirewallArn *string `min:"1" type:"string"` @@ -6136,6 +6352,12 @@ func (s *Firewall) SetDescription(v string) *Firewall { return s } +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *Firewall) SetEncryptionConfiguration(v *EncryptionConfiguration) *Firewall { + s.EncryptionConfiguration = v + return s +} + // SetFirewallArn sets the FirewallArn field's value. func (s *Firewall) SetFirewallArn(v string) *Firewall { s.FirewallArn = &v @@ -6257,8 +6479,8 @@ type FirewallPolicy struct { // // * aws:alert_established // - // For more information, see Strict evaluation order (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-strict-rule-evaluation-order.html) - // in the AWS Network Firewall Developer Guide. + // For more information, see Strict evaluation order (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) + // in the Network Firewall Developer Guide. StatefulDefaultActions []*string `type:"list"` // Additional options governing how Network Firewall handles stateful rules. @@ -6480,6 +6702,10 @@ type FirewallPolicyResponse struct { // A description of the firewall policy. Description *string `type:"string"` + // A complex type that contains the Amazon Web Services KMS encryption configuration + // settings for your firewall policy. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + // The Amazon Resource Name (ARN) of the firewall policy. // // If this response is for a create request that had DryRun set to TRUE, then @@ -6547,6 +6773,12 @@ func (s *FirewallPolicyResponse) SetDescription(v string) *FirewallPolicyRespons return s } +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *FirewallPolicyResponse) SetEncryptionConfiguration(v *EncryptionConfiguration) *FirewallPolicyResponse { + s.EncryptionConfiguration = v + return s +} + // SetFirewallPolicyArn sets the FirewallPolicyArn field's value. func (s *FirewallPolicyResponse) SetFirewallPolicyArn(v string) *FirewallPolicyResponse { s.FirewallPolicyArn = &v @@ -6657,9 +6889,9 @@ func (s *FirewallStatus) SetSyncStates(v map[string]*SyncState) *FirewallStatus return s } -// The basic rule criteria for AWS Network Firewall to use to inspect packet -// headers in stateful traffic flow inspection. Traffic flows that match the -// criteria are a match for the corresponding StatefulRule. +// The basic rule criteria for Network Firewall to use to inspect packet headers +// in stateful traffic flow inspection. Traffic flows that match the criteria +// are a match for the corresponding StatefulRule. type Header struct { _ struct{} `type:"structure"` @@ -6700,7 +6932,7 @@ type Header struct { Direction *string `type:"string" required:"true" enum:"StatefulRuleDirection"` // The protocol to inspect for. To specify all, you can use IP, because all - // traffic on AWS and on the internet is IP. + // traffic on Amazon Web Services and on the internet is IP. // // Protocol is a required field Protocol *string `type:"string" required:"true" enum:"StatefulRuleProtocol"` @@ -6876,8 +7108,8 @@ func (s *IPSet) SetDefinition(v []*string) *IPSet { return s } -// AWS doesn't currently have enough available capacity to fulfill your request. -// Try your request later. +// Amazon Web Services doesn't currently have enough available capacity to fulfill +// your request. Try your request later. type InsufficientCapacityException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -7805,10 +8037,10 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput return s } -// Defines where AWS Network Firewall sends logs for the firewall for one log -// type. This is used in LoggingConfiguration. You can send each type of log -// to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose -// delivery stream. +// Defines where Network Firewall sends logs for the firewall for one log type. +// This is used in LoggingConfiguration. You can send each type of log to an +// Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery +// stream. // // Network Firewall generates logs for stateful rule groups. You can save alert // and flow log types. The stateful rules engine records flow logs for all network @@ -7975,7 +8207,7 @@ func (s *LogDestinationPermissionException) RequestID() string { return s.RespMetadata.RequestID } -// Defines how AWS Network Firewall performs logging for a Firewall. +// Defines how Network Firewall performs logging for a Firewall. type LoggingConfiguration struct { _ struct{} `type:"structure"` @@ -8392,9 +8624,9 @@ func (s *PublishMetricAction) SetDimensions(v []*Dimension) *PublishMetricAction type PutResourcePolicyInput struct { _ struct{} `type:"structure"` - // The AWS Identity and Access Management policy statement that lists the accounts - // that you want to share your rule group or firewall policy with and the operations - // that you want the accounts to be able to perform. + // The IAM policy statement that lists the accounts that you want to share your + // rule group or firewall policy with and the operations that you want the accounts + // to be able to perform. // // For a rule group resource, you can specify the following operations in the // Actions section of the statement: @@ -8632,10 +8864,9 @@ func (s *ResourceOwnerCheckException) RequestID() string { return s.RespMetadata.RequestID } -// The inspection criteria and action for a single stateless rule. AWS Network -// Firewall inspects each packet for the specified matching criteria. When a -// packet matches the criteria, Network Firewall performs the rule's actions -// on the packet. +// The inspection criteria and action for a single stateless rule. Network Firewall +// inspects each packet for the specified matching criteria. When a packet matches +// the criteria, Network Firewall performs the rule's actions on the packet. type RuleDefinition struct { _ struct{} `type:"structure"` @@ -8734,7 +8965,7 @@ func (s *RuleDefinition) SetMatchAttributes(v *MatchAttributes) *RuleDefinition // define the rule group. You can retrieve all objects for a rule group by calling // DescribeRuleGroup. // -// AWS Network Firewall uses a rule group to inspect and control network traffic. +// Network Firewall uses a rule group to inspect and control network traffic. // You define stateless rule groups to inspect individual packets and you define // stateful rule groups to inspect packets in the context of their traffic flow. // @@ -8884,6 +9115,10 @@ type RuleGroupResponse struct { // A description of the rule group. Description *string `type:"string"` + // A complex type that contains the Amazon Web Services KMS encryption configuration + // settings for your rule group. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + // The number of firewall policies that use this rule group. NumberOfAssociations *int64 `type:"integer"` @@ -8954,6 +9189,12 @@ func (s *RuleGroupResponse) SetDescription(v string) *RuleGroupResponse { return s } +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *RuleGroupResponse) SetEncryptionConfiguration(v *EncryptionConfiguration) *RuleGroupResponse { + s.EncryptionConfiguration = v + return s +} + // SetNumberOfAssociations sets the NumberOfAssociations field's value. func (s *RuleGroupResponse) SetNumberOfAssociations(v int64) *RuleGroupResponse { s.NumberOfAssociations = &v @@ -9225,7 +9466,7 @@ func (s *RulesSource) SetStatelessRulesAndCustomActions(v *StatelessRulesAndCust // IP addresses outside of the deployment VPC, you set the HOME_NET rule variable // to include the CIDR range of the deployment VPC plus the other CIDR ranges. // For more information, see RuleVariables in this guide and Stateful domain -// list rule groups in AWS Network Firewall (https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) +// list rule groups in Network Firewall (https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) // in the Network Firewall Developer Guide. type RulesSourceList struct { _ struct{} `type:"structure"` @@ -9320,7 +9561,7 @@ type StatefulEngineOptions struct { // to the rule engine as Suricata compatible strings, and Suricata evaluates // them based on certain settings. For more information, see Evaluation order // for stateful rules (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) - // in the AWS Network Firewall Developer Guide. + // in the Network Firewall Developer Guide. RuleOrder *string `type:"string" enum:"RuleOrder"` } @@ -9586,7 +9827,7 @@ type StatefulRuleOptions struct { // to the rule engine as Suricata compatible strings, and Suricata evaluates // them based on certain settings. For more information, see Evaluation order // for stateful rules (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) - // in the AWS Network Firewall Developer Guide. + // in the Network Firewall Developer Guide. RuleOrder *string `type:"string" enum:"RuleOrder"` } @@ -9850,9 +10091,9 @@ func (s *StatelessRulesAndCustomActions) SetStatelessRules(v []*StatelessRule) * } // The ID for a subnet that you want to associate with the firewall. This is -// used with CreateFirewall and AssociateSubnets. AWS Network Firewall creates -// an instance of the associated firewall in each subnet that you specify, to -// filter traffic in the subnet's Availability Zone. +// used with CreateFirewall and AssociateSubnets. Network Firewall creates an +// instance of the associated firewall in each subnet that you specify, to filter +// traffic in the subnet's Availability Zone. type SubnetMapping struct { _ struct{} `type:"structure"` @@ -9902,7 +10143,7 @@ func (s *SubnetMapping) SetSubnetId(v string) *SubnetMapping { // The status of the firewall endpoint and firewall policy configuration for // a single VPC subnet. // -// For each VPC subnet that you associate with a firewall, AWS Network Firewall +// For each VPC subnet that you associate with a firewall, Network Firewall // does the following: // // * Instantiates a firewall endpoint in the subnet, ready to take traffic. @@ -10028,11 +10269,11 @@ func (s *TCPFlagField) SetMasks(v []*string) *TCPFlagField { return s } -// A key:value pair associated with an AWS resource. The key:value pair can -// be anything you define. Typically, the tag key represents a category (such -// as "environment") and the tag value represents a specific value within that -// category (such as "test," "development," or "production"). You can add up -// to 50 tags to each AWS resource. +// A key:value pair associated with an Amazon Web Services resource. The key:value +// pair can be anything you define. Typically, the tag key represents a category +// (such as "environment") and the tag value represents a specific value within +// that category (such as "test," "development," or "production"). You can add +// up to 50 tags to each Amazon Web Services resource. type Tag struct { _ struct{} `type:"structure"` @@ -10755,6 +10996,188 @@ func (s *UpdateFirewallDescriptionOutput) SetUpdateToken(v string) *UpdateFirewa return s } +type UpdateFirewallEncryptionConfigurationInput struct { + _ struct{} `type:"structure"` + + // A complex type that contains optional Amazon Web Services Key Management + // Service (KMS) encryption settings for your Network Firewall resources. Your + // data is encrypted by default with an Amazon Web Services owned key that Amazon + // Web Services owns and manages for you. You can use either the Amazon Web + // Services owned key, or provide your own customer managed key. To learn more + // about KMS encryption of your Network Firewall resources, see Encryption at + // rest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) + // in the Network Firewall Developer Guide. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + + // The Amazon Resource Name (ARN) of the firewall. + FirewallArn *string `min:"1" type:"string"` + + // The descriptive name of the firewall. You can't change the name of a firewall + // after you create it. + FirewallName *string `min:"1" type:"string"` + + // An optional token that you can use for optimistic locking. Network Firewall + // returns a token to your requests that access the firewall. The token marks + // the state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless + // of whether the firewall has changed since you last retrieved it. + // + // To make a conditional change to the firewall, provide the token in your update + // request. Network Firewall uses the token to ensure that the firewall hasn't + // changed since you last retrieved it. If it has changed, the operation fails + // with an InvalidTokenException. If this happens, retrieve the firewall again + // to get a current copy of it with a new token. Reapply your changes as needed, + // then try the operation again using the new token. + UpdateToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFirewallEncryptionConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFirewallEncryptionConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateFirewallEncryptionConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateFirewallEncryptionConfigurationInput"} + if s.FirewallArn != nil && len(*s.FirewallArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FirewallArn", 1)) + } + if s.FirewallName != nil && len(*s.FirewallName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FirewallName", 1)) + } + if s.UpdateToken != nil && len(*s.UpdateToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UpdateToken", 1)) + } + if s.EncryptionConfiguration != nil { + if err := s.EncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *UpdateFirewallEncryptionConfigurationInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *UpdateFirewallEncryptionConfigurationInput { + s.EncryptionConfiguration = v + return s +} + +// SetFirewallArn sets the FirewallArn field's value. +func (s *UpdateFirewallEncryptionConfigurationInput) SetFirewallArn(v string) *UpdateFirewallEncryptionConfigurationInput { + s.FirewallArn = &v + return s +} + +// SetFirewallName sets the FirewallName field's value. +func (s *UpdateFirewallEncryptionConfigurationInput) SetFirewallName(v string) *UpdateFirewallEncryptionConfigurationInput { + s.FirewallName = &v + return s +} + +// SetUpdateToken sets the UpdateToken field's value. +func (s *UpdateFirewallEncryptionConfigurationInput) SetUpdateToken(v string) *UpdateFirewallEncryptionConfigurationInput { + s.UpdateToken = &v + return s +} + +type UpdateFirewallEncryptionConfigurationOutput struct { + _ struct{} `type:"structure"` + + // A complex type that contains optional Amazon Web Services Key Management + // Service (KMS) encryption settings for your Network Firewall resources. Your + // data is encrypted by default with an Amazon Web Services owned key that Amazon + // Web Services owns and manages for you. You can use either the Amazon Web + // Services owned key, or provide your own customer managed key. To learn more + // about KMS encryption of your Network Firewall resources, see Encryption at + // rest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) + // in the Network Firewall Developer Guide. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + + // The Amazon Resource Name (ARN) of the firewall. + FirewallArn *string `min:"1" type:"string"` + + // The descriptive name of the firewall. You can't change the name of a firewall + // after you create it. + FirewallName *string `min:"1" type:"string"` + + // An optional token that you can use for optimistic locking. Network Firewall + // returns a token to your requests that access the firewall. The token marks + // the state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless + // of whether the firewall has changed since you last retrieved it. + // + // To make a conditional change to the firewall, provide the token in your update + // request. Network Firewall uses the token to ensure that the firewall hasn't + // changed since you last retrieved it. If it has changed, the operation fails + // with an InvalidTokenException. If this happens, retrieve the firewall again + // to get a current copy of it with a new token. Reapply your changes as needed, + // then try the operation again using the new token. + UpdateToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFirewallEncryptionConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateFirewallEncryptionConfigurationOutput) GoString() string { + return s.String() +} + +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *UpdateFirewallEncryptionConfigurationOutput) SetEncryptionConfiguration(v *EncryptionConfiguration) *UpdateFirewallEncryptionConfigurationOutput { + s.EncryptionConfiguration = v + return s +} + +// SetFirewallArn sets the FirewallArn field's value. +func (s *UpdateFirewallEncryptionConfigurationOutput) SetFirewallArn(v string) *UpdateFirewallEncryptionConfigurationOutput { + s.FirewallArn = &v + return s +} + +// SetFirewallName sets the FirewallName field's value. +func (s *UpdateFirewallEncryptionConfigurationOutput) SetFirewallName(v string) *UpdateFirewallEncryptionConfigurationOutput { + s.FirewallName = &v + return s +} + +// SetUpdateToken sets the UpdateToken field's value. +func (s *UpdateFirewallEncryptionConfigurationOutput) SetUpdateToken(v string) *UpdateFirewallEncryptionConfigurationOutput { + s.UpdateToken = &v + return s +} + type UpdateFirewallPolicyChangeProtectionInput struct { _ struct{} `type:"structure"` @@ -10952,6 +11375,10 @@ type UpdateFirewallPolicyInput struct { // If set to FALSE, Network Firewall makes the requested changes to your resources. DryRun *bool `type:"boolean"` + // A complex type that contains settings for encryption of your firewall policy + // resources. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + // The updated firewall policy to use for the firewall. // // FirewallPolicy is a required field @@ -11019,6 +11446,11 @@ func (s *UpdateFirewallPolicyInput) Validate() error { if s.UpdateToken != nil && len(*s.UpdateToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("UpdateToken", 1)) } + if s.EncryptionConfiguration != nil { + if err := s.EncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfiguration", err.(request.ErrInvalidParams)) + } + } if s.FirewallPolicy != nil { if err := s.FirewallPolicy.Validate(); err != nil { invalidParams.AddNested("FirewallPolicy", err.(request.ErrInvalidParams)) @@ -11043,6 +11475,12 @@ func (s *UpdateFirewallPolicyInput) SetDryRun(v bool) *UpdateFirewallPolicyInput return s } +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *UpdateFirewallPolicyInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *UpdateFirewallPolicyInput { + s.EncryptionConfiguration = v + return s +} + // SetFirewallPolicy sets the FirewallPolicy field's value. func (s *UpdateFirewallPolicyInput) SetFirewallPolicy(v *FirewallPolicy) *UpdateFirewallPolicyInput { s.FirewallPolicy = v @@ -11208,7 +11646,7 @@ type UpdateLoggingConfigurationOutput struct { // after you create it. FirewallName *string `min:"1" type:"string"` - // Defines how AWS Network Firewall performs logging for a Firewall. + // Defines how Network Firewall performs logging for a Firewall. LoggingConfiguration *LoggingConfiguration `type:"structure"` } @@ -11267,6 +11705,9 @@ type UpdateRuleGroupInput struct { // If set to FALSE, Network Firewall makes the requested changes to your resources. DryRun *bool `type:"boolean"` + // A complex type that contains settings for encryption of your rule group resources. + EncryptionConfiguration *EncryptionConfiguration `type:"structure"` + // An object that defines the rule group rules. // // You must provide either this rule group setting or a Rules setting, but not @@ -11352,6 +11793,11 @@ func (s *UpdateRuleGroupInput) Validate() error { if s.UpdateToken != nil && len(*s.UpdateToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("UpdateToken", 1)) } + if s.EncryptionConfiguration != nil { + if err := s.EncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfiguration", err.(request.ErrInvalidParams)) + } + } if s.RuleGroup != nil { if err := s.RuleGroup.Validate(); err != nil { invalidParams.AddNested("RuleGroup", err.(request.ErrInvalidParams)) @@ -11376,6 +11822,12 @@ func (s *UpdateRuleGroupInput) SetDryRun(v bool) *UpdateRuleGroupInput { return s } +// SetEncryptionConfiguration sets the EncryptionConfiguration field's value. +func (s *UpdateRuleGroupInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *UpdateRuleGroupInput { + s.EncryptionConfiguration = v + return s +} + // SetRuleGroup sets the RuleGroup field's value. func (s *UpdateRuleGroupInput) SetRuleGroup(v *RuleGroup) *UpdateRuleGroupInput { s.RuleGroup = v @@ -11685,6 +12137,22 @@ func ConfigurationSyncState_Values() []string { } } +const ( + // EncryptionTypeCustomerKms is a EncryptionType enum value + EncryptionTypeCustomerKms = "CUSTOMER_KMS" + + // EncryptionTypeAwsOwnedKmsKey is a EncryptionType enum value + EncryptionTypeAwsOwnedKmsKey = "AWS_OWNED_KMS_KEY" +) + +// EncryptionType_Values returns all elements of the EncryptionType enum +func EncryptionType_Values() []string { + return []string{ + EncryptionTypeCustomerKms, + EncryptionTypeAwsOwnedKmsKey, + } +} + const ( // FirewallStatusValueProvisioning is a FirewallStatusValue enum value FirewallStatusValueProvisioning = "PROVISIONING" diff --git a/service/networkfirewall/doc.go b/service/networkfirewall/doc.go index 15241fa4fe6..63bd086ba53 100644 --- a/service/networkfirewall/doc.go +++ b/service/networkfirewall/doc.go @@ -3,18 +3,19 @@ // Package networkfirewall provides the client and types for making API // requests to AWS Network Firewall. // -// This is the API Reference for AWS Network Firewall. This guide is for developers +// This is the API Reference for Network Firewall. This guide is for developers // who need detailed information about the Network Firewall API actions, data // types, and errors. // // * The REST API requires you to handle connection details, such as calculating // signatures, handling request retries, and error handling. For general -// information about using the AWS REST APIs, see AWS APIs (https://docs.aws.amazon.com/general/latest/gr/aws-apis.html). +// information about using the Amazon Web Services REST APIs, see Amazon +// Web Services APIs (https://docs.aws.amazon.com/general/latest/gr/aws-apis.html). // To access Network Firewall using the REST API endpoint: https://network-firewall.