Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization. Only a master account can delete an organization config rule.
AWS Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
" + "documentation":"Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization.
Only a master account and a delegated administrator account can delete an organization config rule. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
AWS Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
" }, "DeleteOrganizationConformancePack":{ "name":"DeleteOrganizationConformancePack", @@ -156,7 +156,7 @@ {"shape":"ResourceInUseException"}, {"shape":"OrganizationAccessDeniedException"} ], - "documentation":"Deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization. Only a master account can delete an organization conformance pack.
AWS Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
" + "documentation":"Deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization.
Only a master account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
AWS Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
" }, "DeletePendingAggregationRequest":{ "name":"DeletePendingAggregationRequest", @@ -196,7 +196,7 @@ "errors":[ {"shape":"NoSuchRemediationExceptionException"} ], - "documentation":"Deletes one or more remediation exceptions mentioned in the resource keys.
" + "documentation":"Deletes one or more remediation exceptions mentioned in the resource keys.
AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
Returns a list of one or more conformance packs.
" }, @@ -472,7 +474,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"OrganizationAccessDeniedException"} ], - "documentation":"Provides organization config rule deployment status for an organization.
The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.
Only a master account can call this API.
Provides organization config rule deployment status for an organization.
Only a master account and a delegated administrator account can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.
Returns a list of organization config rules.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.
Only a master account can call this API.
Returns a list of organization config rules.
Only a master account and a delegated administrator account can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.
Provides organization conformance pack deployment status for an organization.
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
Only a master account can call this API.
Provides organization conformance pack deployment status for an organization.
Only a master account and a delegated administrator account can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
Returns a list of organization conformance packs.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
Only a master account can call this API.
Returns a list of organization conformance packs.
Only a master account and a delegated administrator account can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
Returns detailed status for each member account within an organization for a given organization config rule.
Only a master account can call this API.
Returns detailed status for each member account within an organization for a given organization config rule.
Only a master account and a delegated administrator account can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
Returns detailed status for each member account within an organization for a given organization conformance pack.
Only a master account can call this API.
" + "documentation":"Returns detailed status for each member account within an organization for a given organization conformance pack.
Only a master account and a delegated administrator account can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
Creates or updates a conformance pack. A conformance pack is a collection of AWS Config rules that can be easily deployed in an account and a region and across AWS Organization.
This API creates a service linked role AWSServiceRoleForConfigConforms
in your account. The service linked role is created only when the role does not exist in your account. AWS Config verifies the existence of role with GetRole
action.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
Creates or updates a conformance pack. A conformance pack is a collection of AWS Config rules that can be easily deployed in an account and a region and across AWS Organization.
This API creates a service linked role AWSServiceRoleForConfigConforms
in your account. The service linked role is created only when the role does not exist in your account.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations. Only a master account can create or update an organization config rule.
This API enables organization service access through the EnableAWSServiceAccess
action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup
in the master account of your organization. The service linked role is created only when the role does not exist in the master account. AWS Config verifies the existence of role with GetRole
action.
You can use this action to create both custom AWS Config rules and AWS managed Config rules. If you are adding a new custom AWS Config rule, you must first create AWS Lambda function in the master account that the rule invokes to evaluate your resources. When you use the PutOrganizationConfigRule
action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. If you are adding an AWS managed Config rule, specify the rule's identifier for the RuleIdentifier
key.
The maximum number of organization config rules that AWS Config supports is 150.
Specify either OrganizationCustomRuleMetadata
or OrganizationManagedRuleMetadata
.
Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations.
Only a master account and a delegated administrator can create or update an organization config rule. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
This API enables organization service access through the EnableAWSServiceAccess
action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup
in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. AWS Config verifies the existence of role with GetRole
action.
To use this API with delegated administrator, register a delegated administrator by calling AWS Organization register-delegated-administrator
for config-multiaccountsetup.amazonaws.com
.
You can use this action to create both custom AWS Config rules and AWS managed Config rules. If you are adding a new custom AWS Config rule, you must first create AWS Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. When you use the PutOrganizationConfigRule
action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. If you are adding an AWS managed Config rule, specify the rule's identifier for the RuleIdentifier
key.
The maximum number of organization config rules that AWS Config supports is 150 and 3 delegated administrator per organization.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
Specify either OrganizationCustomRuleMetadata
or OrganizationManagedRuleMetadata
.
Deploys conformance packs across member accounts in an AWS Organization.
This API enables organization service access for config-multiaccountsetup.amazonaws.com
through the EnableAWSServiceAccess
action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup
in the master account of your organization. The service linked role is created only when the role does not exist in the master account. AWS Config verifies the existence of role with GetRole action.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
AWS Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the confomance pack is created or updated. You cannot update a conformance pack while it is in this state.
You can create 6 conformance packs with 25 AWS Config rules in each pack.
Deploys conformance packs across member accounts in an AWS Organization.
Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
This API enables organization service access for config-multiaccountsetup.amazonaws.com
through the EnableAWSServiceAccess
action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup
in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling AWS Organization register-delegate-admin
for config-multiaccountsetup.amazonaws.com
.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
AWS Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
You can create 6 conformance packs with 25 AWS Config rules in each pack and 3 delegated administrator per organization.
Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration
object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.
Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration
object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.
If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.
A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule.
" + "documentation":"A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule.
AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in AWS Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing AWS Config APIs.
The custom resource type must be registered with AWS CloudFormation. This API accepts the configuration item registered with AWS CloudFormation.
When you call this API, AWS Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in AWS Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing AWS Config APIs.
The custom resource type must be registered with AWS CloudFormation. This API accepts the configuration item registered with AWS CloudFormation.
When you call this API, AWS Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
Write-only schema properites are not recorded as part of the published configuration item.
The configuration item status.
" + "documentation":"The configuration item status. The valid values are:
OK – The resource configuration has been updated
ResourceDiscovered – The resource was newly discovered
ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
ResourceDeleted – The resource was deleted
ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
The CIs do not incur any cost.
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
" + "documentation":"Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
The scope can be empty.
The time that you first activated the AWS Config rule.
" }, - "LastDeactivatedTime":{"shape":"Date"}, + "LastDeactivatedTime":{ + "shape":"Date", + "documentation":"The time that you last turned off the AWS Config rule.
" + }, "LastErrorCode":{ "shape":"String", "documentation":"The error code that AWS Config returned when the rule last failed.
" @@ -1961,6 +1967,10 @@ "LastUpdatedTime":{ "shape":"Date", "documentation":"The time of the last update.
" + }, + "CreatedBy":{ + "shape":"StringWithCharLimit256", + "documentation":"AWS service that created the configuration aggregator.
" } }, "documentation":"The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.
" @@ -2002,7 +2012,7 @@ }, "configurationItemStatus":{ "shape":"ConfigurationItemStatus", - "documentation":"The configuration item status.
" + "documentation":"The configuration item status. The valid values are:
OK – The resource configuration has been updated
ResourceDiscovered – The resource was newly discovered
ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
ResourceDeleted – The resource was deleted
ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type
The CIs do not incur any cost.
Another part of the key-value pair.
" } }, - "documentation":"Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 128 characters, and values can have a maximum length of 256 characters.
" + "documentation":"Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
" }, "ConformancePackInputParameters":{ "type":"list", @@ -5608,7 +5618,7 @@ }, "TargetVersion":{ "shape":"String", - "documentation":"Version of the target. For example, version of the SSM document.
" + "documentation":"Version of the target. For example, version of the SSM document.
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptsSeconds as 50 seconds, AWS Config throws an exception after the 5th failed attempt within 50 seconds.
" + "documentation":"The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptsSeconds as 50 seconds, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
" }, "RetryAttemptSeconds":{ "shape":"AutoRemediationAttemptSeconds", - "documentation":"Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
" + "documentation":"Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
" }, "Arn":{ "shape":"StringWithCharLimit1024", @@ -6061,7 +6071,10 @@ "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", - "AWS::QLDB::Ledger" + "AWS::QLDB::Ledger", + "AWS::SecretsManager::Secret", + "AWS::SNS::Topic", + "AWS::SSM::FileData" ] }, "ResourceTypeList":{ @@ -6195,7 +6208,10 @@ "shape":"Limit", "documentation":"The maximum number of query results returned on each page.
" }, - "MaxResults":{"shape":"Limit"}, + "MaxResults":{ + "shape":"Limit", + "documentation":"The maximum number of query results returned on each page. AWS Config also allows the Limit request parameter.
" + }, "NextToken":{ "shape":"NextToken", "documentation":"The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
" diff --git a/services/connect/pom.xml b/services/connect/pom.xml index 50ef3606ba3a..cf97e87bf88a 100644 --- a/services/connect/pom.xml +++ b/services/connect/pom.xml @@ -21,7 +21,7 @@Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
You can only associate a Direct Connect gateway and virtual private gateway or transit gateway when the account that owns the Direct Connect gateway and the account that owns the virtual private gateway or transit gateway have the same AWS Payer ID.
" + "documentation":"Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any AWS account.
" }, "CreateInterconnect":{ "name":"CreateInterconnect", diff --git a/services/directory/pom.xml b/services/directory/pom.xml index 02a6498fcb7d..d4e134cf0e69 100644 --- a/services/directory/pom.xml +++ b/services/directory/pom.xml @@ -21,7 +21,7 @@The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days. The default is 0.
", @@ -713,6 +721,10 @@ "shape":"LustreDeploymentType", "documentation":" Choose SCRATCH_1
and SCRATCH_2
deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2
deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1
.
This option can only be set for for PERSISTENT_1 deployments types.
Choose PERSISTENT_1
deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options.
Encryption of data in-transit is automatically enabled when you access a SCRATCH_2
or PERSISTENT_1
file system from Amazon EC2 instances that support this feature. (Default = SCRATCH_1
)
Encryption of data in-transit for SCRATCH_2
and PERSISTENT_1
deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, Encrypting Data in Transit.
Use this property to turn the Autoimport feature on and off. AutoImport enables your FSx for Lustre file system to automatically update its contents with changes that have been made to its linked Amazon S3 data repository. You can set the policy to have one the following values:
NONE
- (Default) Autoimport is turned off. Changes to your S3 repository will not be reflected on the FSx file system.
NEW
- Autoimport is turned on; only new files in the linked S3 repository will be imported to the FSx file system. Updates to existing files and deleted files will not be imported to the FSx file system.
NEW_CHANGED
- Autoimport is turned on; new files and changes to existing files in the linked S3 repository will be imported to the FSx file system. Files deleted in S3 are not deleted in the FSx file system.
NEW_CHANGED_DELETED
- Autoimport is turned on; new files, changes to existing files, and deleted files in the linked S3 repository will be imported to the FSx file system.
Required for the PERSISTENT_1
deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 117 MB/s of file system throughput. You pay for the amount of throughput that you provision.
Valid values are 50, 100, 200.
" @@ -843,6 +855,10 @@ "DataRepositoryConfiguration":{ "type":"structure", "members":{ + "Lifecycle":{ + "shape":"DataRepositoryLifecycle", + "documentation":"Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING
- Amazon FSx is creating the new data repository.
AVAILABLE
- The data repository is available for use.
MISCONFIGURED
- The data repository is in a failed but recoverable state.
UPDATING
- The data repository is undergoing a customer initiated update.
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix
. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
" - } + }, + "AutoImportPolicy":{ + "shape":"AutoImportPolicyType", + "documentation":"Describes the data repository's AutoImportPolicy
. AutoImport enables your FSx for Lustre file system to automatically update its contents with changes that have been made to its linked Amazon S3 data repository. The policy can have the following values:
NONE
- (Default) Autoimport is turned off, Changes to your S3 repository will not be reflected on the FSx file system.
NEW
- Autoimport is turned on; only new files in the linked S3 repository will be imported to the FSx file system. Updates to existing files and deleted files will not be imported to the FSx file system.
NEW_CHANGED
- Autoimport is turned on; new files and changes to existing files in the linked S3 repository will be imported to the FSx file system. Files deleted in S3 are not deleted in the FSx file system.
NEW_CHANGED_DELETED
- Autoimport is turned on; new files, changes to existing files, and deleted files in the linked S3 repository will be imported to the FSx file system.
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem
operation.
Provides detailed information about the data respository if its Lifecycle
is set to MISCONFIGURED
.
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" }, "DailyAutomaticBackupStartTime":{"shape":"DailyTime"}, - "AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"} + "AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"}, + "AutoImportPolicy":{ + "shape":"AutoImportPolicyType", + "documentation":"Use this property to turn the Autoimport feature on and off. AutoImport enables your FSx for Lustre file system to automatically update its contents with changes that have been made to its linked Amazon S3 data repository. You can set the policy to have one the following values:
NONE
- (Default) Autoimport is turned off. Changes to your S3 repository will not be reflected on the FSx file system.
NEW
- Autoimport is turned on; only new files in the linked S3 repository will be imported to the FSx file system. Updates to existing files and deleted files will not be imported to the FSx file system.
NEW_CHANGED
- Autoimport is turned on; new files and changes to existing files in the linked S3 repository will be imported to the FSx file system. Files deleted in S3 are not deleted in the FSx file system.
NEW_CHANGED_DELETED
- Autoimport is turned on; new files, changes to existing files, and deleted files in the linked S3 repository will be imported to the FSx file system.
The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem
operation.
Retrieves the security configurations for the resource policies set on individual resources, and also the account-level policy.
" + "documentation":"Retrieves the security configurations for the resource policies set on individual resources, and also the account-level policy.
This operation also returns the Data Catalog resource policy. However, if you enabled metadata encryption in Data Catalog settings, and you do not have permission on the AWS KMS key, the operation can't return the Data Catalog resource policy.
" }, "GetResourcePolicy":{ "name":"GetResourcePolicy", @@ -3235,7 +3235,7 @@ }, "ConnectionProperties":{ "shape":"ConnectionProperties", - "documentation":"These key-value pairs define parameters for the connection:
HOST
- The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT
- The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME
- The name under which to log in to the database. The value string for USER_NAME
is \"USERNAME
\".
PASSWORD
- A password, if one is used, for the user name.
ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
JDBC_ENGINE
- The name of the JDBC engine to use.
JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
CONFIG_FILES
- (Reserved for future use.)
INSTANCE_ID
- The instance ID to use.
JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. AWS Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip AWS Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
These key-value pairs define parameters for the connection:
HOST
- The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
PORT
- The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
USER_NAME
- The name under which to log in to the database. The value string for USER_NAME
is \"USERNAME
\".
PASSWORD
- A password, if one is used, for the user name.
ENCRYPTED_PASSWORD
- When you enable connection password protection by setting ConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password.
JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
JDBC_DRIVER_CLASS_NAME
- The class name of the JDBC driver to use.
JDBC_ENGINE
- The name of the JDBC engine to use.
JDBC_ENGINE_VERSION
- The version of the JDBC engine to use.
CONFIG_FILES
- (Reserved for future use.)
INSTANCE_ID
- The instance ID to use.
JDBC_CONNECTION_URL
- The URL for connecting to a JDBC data source.
JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. AWS Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this is false
. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true
to skip AWS Glue’s validation of the customer certificate.
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as the hostNameInCertificate
.
CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source.
KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".
KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. AWS Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".
A unique identifier, consisting of account_id/datalake
.
A unique identifier, consisting of account_id
.
A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
" + "documentation":"A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator
member of the PropertyPredicate
struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name
, a fuzzy match algorithm is used. The Key
field (for example, the value of the Name
field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value
member of PropertyPredicate
. For example, if Key=Name
and Value=link
, tables named customer-link
and xx-link-yy
are returned, but xxlinkyy
is not returned.
A list of the values defining the partition.
" + "documentation":"List of partition key values that define the partition to update.
" }, "PartitionInput":{ "shape":"PartitionInput", - "documentation":"The new partition object to update the partition to.
" + "documentation":"The new partition object to update the partition to.
The Values
property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.
Allocates a static IP address.
" }, + "AttachCertificateToDistribution":{ + "name":"AttachCertificateToDistribution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachCertificateToDistributionRequest"}, + "output":{"shape":"AttachCertificateToDistributionResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"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.
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.
Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is created, use the AttachCertificateToDistribution
action to attach the certificate 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.
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name
parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot
operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
" + }, "CreateDomain":{ "name":"CreateDomain", "http":{ @@ -484,6 +537,23 @@ ], "documentation":"Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
" }, + "DeleteCertificate":{ + "name":"DeleteCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCertificateRequest"}, + "output":{"shape":"DeleteCertificateResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"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 the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
The delete disk snapshot
operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name
. For more information, see the Lightsail Dev Guide.
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
" + }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ @@ -730,6 +818,24 @@ ], "documentation":"Deletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot
operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
" + }, "DetachDisk":{ "name":"DetachDisk", "http":{ @@ -954,6 +1060,23 @@ ], "documentation":"Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
" }, + "GetCertificates":{ + "name":"GetCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCertificatesRequest"}, + "output":{"shape":"GetCertificatesResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"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 information about all block storage disks in your AWS account and region.
" }, + "GetDistributionBundles":{ + "name":"GetDistributionBundles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDistributionBundlesRequest"}, + "output":{"shape":"GetDistributionBundlesResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.
" + }, + "GetDistributionLatestCacheReset":{ + "name":"GetDistributionLatestCacheReset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDistributionLatestCacheResetRequest"}, + "output":{"shape":"GetDistributionLatestCacheResetResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
" + }, + "GetDistributionMetricData":{ + "name":"GetDistributionMetricData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDistributionMetricDataRequest"}, + "output":{"shape":"GetDistributionMetricDataResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
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.
" + }, + "GetDistributions":{ + "name":"GetDistributions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDistributionsRequest"}, + "output":{"shape":"GetDistributionsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
" + }, "GetDomain":{ "name":"GetDomain", "http":{ @@ -1902,6 +2097,24 @@ ], "documentation":"Deletes a specific static IP from your account.
" }, + "ResetDistributionCache":{ + "name":"ResetDistributionCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDistributionCacheRequest"}, + "output":{"shape":"ResetDistributionCacheResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"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":{ "name":"SendContactMethodVerification", "http":{ @@ -2071,6 +2284,42 @@ ], "documentation":"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 Lightsail Dev Guide.
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution
" + }, + "UpdateDistributionBundle":{ + "name":"UpdateDistributionBundle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDistributionBundleRequest"}, + "output":{"shape":"UpdateDistributionBundleResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions
action. The ableToUpdateBundle
parameter in the result will indicate whether you can currently update your distribution's bundle.
The name of the distribution that the certificate will be attached to.
Use the GetDistributions
action to get a list of distribution names that you can specify.
The name of the certificate to attach to a distribution.
Only certificates with a status of ISSUED
can be attached to a distribution.
Use the GetCertificates
action to get a list of certificate names that you can specify.
This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate
and the domain name of the certificate might be example.com
.
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.
" + } + } + }, "AttachDiskRequest":{ "type":"structure", "required":[ @@ -2544,6 +2819,13 @@ "member":{"shape":"AvailabilityZone"} }, "Base64":{"type":"string"}, + "BehaviorEnum":{ + "type":"string", + "enum":[ + "dont-cache", + "cache" + ] + }, "Blueprint":{ "type":"structure", "members":{ @@ -2663,69 +2945,272 @@ "type":"list", "member":{"shape":"Bundle"} }, - "CloseInstancePublicPortsRequest":{ + "CacheBehavior":{ "type":"structure", - "required":[ - "portInfo", - "instanceName" - ], "members":{ - "portInfo":{ - "shape":"PortInfo", - "documentation":"An object to describe the ports to close for the specified instance.
" - }, - "instanceName":{ - "shape":"ResourceName", - "documentation":"The name of the instance for which to close ports.
" + "behavior":{ + "shape":"BehaviorEnum", + "documentation":"The cache behavior of the distribution.
The following cache behaviors can be specified:
cache
- This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
dont-cache
- This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath
parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
" }, - "CloseInstancePublicPortsResult":{ + "CacheBehaviorList":{ + "type":"list", + "member":{"shape":"CacheBehaviorPerPath"} + }, + "CacheBehaviorPerPath":{ "type":"structure", "members":{ - "operation":{ - "shape":"Operation", - "documentation":"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.
" + "path":{ + "shape":"string", + "documentation":"The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*
), and file types (*.html, *jpg, *js
). Directories and file paths are case-sensitive.
Examples:
Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.
var/www/html/
Specify the following file to cache only the index page in the document root of an Apache web server.
var/www/html/index.html
Specify the following to cache only the .html files in the document root of an Apache web server.
var/www/html/*.html
Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.
var/www/html/images/*.jpg
var/www/html/images/*.png
var/www/html/images/*.gif
Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.
var/www/html/images/
The cache behavior for the specified path.
You can specify one of the following per-path cache behaviors:
cache
- This behavior caches the specified path.
dont-cache
- This behavior doesn't cache the specified path.
Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior
is set to cache
, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior
is dont-cache
, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
if the cacheBehavior's behavior is set to 'cache', then
" }, - "CloudFormationStackRecord":{ + "CacheSettings":{ "type":"structure", "members":{ - "name":{ - "shape":"ResourceName", - "documentation":"The name of the CloudFormation stack record. It starts with CloudFormationStackRecord
followed by a GUID.
The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age
, Cache-Control s-maxage
, and Expires
to objects.
The Amazon Resource Name (ARN) of the CloudFormation stack record.
" + "minimumTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
A value of 0
must be specified for minimumTTL
if the distribution is configured to forward all headers to the origin.
The date when the CloudFormation stack record was created.
" + "maximumTTL":{ + "shape":"long", + "documentation":"The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age
, Cache-Control s-maxage
, and Expires
to objects.
A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
" + "allowedHTTPMethods":{ + "shape":"NonEmptyString", + "documentation":"The HTTP methods that are processed and forwarded to the distribution's origin.
You can specify the following options:
GET,HEAD
- The distribution forwards the GET
and HEAD
methods.
GET,HEAD,OPTIONS
- The distribution forwards the GET
, HEAD
, and OPTIONS
methods.
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE
- The distribution forwards the GET
, HEAD
, OPTIONS
, PUT
, PATCH
, POST
, and DELETE
methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
" }, - "resourceType":{ - "shape":"ResourceType", - "documentation":"The Lightsail resource type (e.g., CloudFormationStackRecord
).
The HTTP method responses that are cached by your distribution.
You can specify the following options:
GET,HEAD
- The distribution caches responses to the GET
and HEAD
methods.
GET,HEAD,OPTIONS
- The distribution caches responses to the GET
, HEAD
, and OPTIONS
methods.
The current state of the CloudFormation stack record.
" + "forwardedCookies":{ + "shape":"CookieObject", + "documentation":"An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
" }, - "sourceInfo":{ - "shape":"CloudFormationStackRecordSourceInfoList", - "documentation":"A list of objects describing the source of the CloudFormation stack record.
" + "forwardedHeaders":{ + "shape":"HeaderObject", + "documentation":"An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
" }, - "destinationInfo":{ - "shape":"DestinationInfo", - "documentation":"A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
" + "forwardedQueryStrings":{ + "shape":"QueryStringObject", + "documentation":"An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
" } }, - "documentation":"Describes a CloudFormation stack record created as a result of the create cloud formation stack
operation.
A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.
" + "documentation":"Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.
These settings apply only to your distribution's cacheBehaviors
(including the defaultCacheBehavior
) that have a behavior
of cache
.
The Amazon Resource Name (ARN) of the certificate.
" + }, + "name":{ + "shape":"CertificateName", + "documentation":"The name of the certificate (e.g., my-certificate
).
The domain name of the certificate.
" + }, + "status":{ + "shape":"CertificateStatus", + "documentation":"The validation status of the certificate.
" + }, + "serialNumber":{ + "shape":"SerialNumber", + "documentation":"The serial number of the certificate.
" + }, + "subjectAlternativeNames":{ + "shape":"SubjectAlternativeNameList", + "documentation":"An array of strings that specify the alternate domains (e.g., example2.com
) and subdomains (e.g., blog.example.com
) of the certificate.
An array of objects that describe the domain validation records of the certificate.
" + }, + "requestFailureReason":{ + "shape":"RequestFailureReason", + "documentation":"The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS
- This failure applies to email validation, which is not available for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED
- Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED
- One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
INVALID_PUBLIC_DOMAIN
- One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain
because invalidpublicdomain
is not a valid top-level domain.
OTHER
- Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
The number of Lightsail resources that the certificate is attached to.
" + }, + "keyAlgorithm":{ + "shape":"KeyAlgorithm", + "documentation":"The algorithm used to generate the key pair (the public and private key) of the certificate.
" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"The timestamp when the certificate was created.
" + }, + "issuedAt":{ + "shape":"IsoDate", + "documentation":"The timestamp when the certificate was issued.
" + }, + "issuerCA":{ + "shape":"IssuerCA", + "documentation":"The certificate authority that issued the certificate.
" + }, + "notBefore":{ + "shape":"IsoDate", + "documentation":"The timestamp when the certificate is first valid.
" + }, + "notAfter":{ + "shape":"IsoDate", + "documentation":"The timestamp when the certificate expires.
" + }, + "eligibleToRenew":{ + "shape":"EligibleToRenew", + "documentation":"The renewal eligibility of the certificate.
" + }, + "renewalSummary":{ + "shape":"RenewalSummary", + "documentation":"An object that describes the status of the certificate renewal managed by Lightsail.
" + }, + "revokedAt":{ + "shape":"IsoDate", + "documentation":"The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED
.
The reason the certificate was revoked. This value is present only when the certificate status is REVOKED
.
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
" + }, + "supportCode":{ + "shape":"string", + "documentation":"The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.
" + } + }, + "documentation":"Describes the full details of an Amazon Lightsail SSL/TLS certificate.
To get a summary of a certificate, use the GetCertificates
action and ommit includeCertificateDetails
from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
The Amazon Resource Name (ARN) of the certificate.
" + }, + "certificateName":{ + "shape":"CertificateName", + "documentation":"The name of the certificate.
" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"The domain name of the certificate.
" + }, + "certificateDetail":{ + "shape":"Certificate", + "documentation":"An object that describes a certificate in detail.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
" + } + }, + "documentation":"Describes an Amazon Lightsail SSL/TLS certificate.
" + }, + "CertificateSummaryList":{ + "type":"list", + "member":{"shape":"CertificateSummary"} + }, + "CloseInstancePublicPortsRequest":{ + "type":"structure", + "required":[ + "portInfo", + "instanceName" + ], + "members":{ + "portInfo":{ + "shape":"PortInfo", + "documentation":"An object to describe the ports to close for the specified instance.
" + }, + "instanceName":{ + "shape":"ResourceName", + "documentation":"The name of the instance for which to close ports.
" + } + } + }, + "CloseInstancePublicPortsResult":{ + "type":"structure", + "members":{ + "operation":{ + "shape":"Operation", + "documentation":"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.
" + } + } + }, + "CloudFormationStackRecord":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"The name of the CloudFormation stack record. It starts with CloudFormationStackRecord
followed by a GUID.
The Amazon Resource Name (ARN) of the CloudFormation stack record.
" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"The date when the CloudFormation stack record was created.
" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The Lightsail resource type (e.g., CloudFormationStackRecord
).
The current state of the CloudFormation stack record.
" + }, + "sourceInfo":{ + "shape":"CloudFormationStackRecordSourceInfoList", + "documentation":"A list of objects describing the source of the CloudFormation stack record.
" + }, + "destinationInfo":{ + "shape":"DestinationInfo", + "documentation":"A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
" + } + }, + "documentation":"Describes a CloudFormation stack record created as a result of the create cloud formation stack
operation.
A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.
" }, "CloudFormationStackRecordList":{ "type":"list", @@ -2832,6 +3317,20 @@ "type":"list", "member":{"shape":"ContactProtocol"} }, + "CookieObject":{ + "type":"structure", + "members":{ + "option":{ + "shape":"ForwardValues", + "documentation":"Specifies which cookies to forward to the distribution's origin for a cache behavior: all
, none
, or allow-list
to forward only the cookies specified in the cookiesAllowList
parameter.
The specific cookies to forward to your distribution's origin.
" + } + }, + "documentation":"Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.
For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.
" + }, "CopySnapshotRequest":{ "type":"structure", "required":[ @@ -2874,6 +3373,44 @@ } } }, + "CreateCertificateRequest":{ + "type":"structure", + "required":[ + "certificateName", + "domainName" + ], + "members":{ + "certificateName":{ + "shape":"CertificateName", + "documentation":"The name for the certificate.
" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"The domain name (e.g., example.com
) for the certificate.
An array of strings that specify the alternate domains (e.g., example2.com
) and subdomains (e.g., blog.example.com
) for the certificate.
You can specify a maximum of nine alternate domains (in addition to the primary domain name).
Wildcard domain entries (e.g., *.example.com
) are not supported.
The tag keys and optional values to add to the certificate during create.
Use the TagResource
action to tag a resource after it's created.
An object that describes the certificate created.
" + }, + "operations":{ + "shape":"OperationList", + "documentation":"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.
" + } + } + }, "CreateCloudFormationStackRequest":{ "type":"structure", "required":["instances"], @@ -2945,7 +3482,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The name for the distribution.
" + }, + "origin":{ + "shape":"InputOrigin", + "documentation":"An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
The distribution pulls, caches, and serves content from the origin.
" + }, + "defaultCacheBehavior":{ + "shape":"CacheBehavior", + "documentation":"An object that describes the default cache behavior for the distribution.
" + }, + "cacheBehaviorSettings":{ + "shape":"CacheSettings", + "documentation":"An object that describes the cache behavior settings for the distribution.
" + }, + "cacheBehaviors":{ + "shape":"CacheBehaviorList", + "documentation":"An array of objects that describe the per-path cache behavior for the distribution.
" + }, + "bundleId":{ + "shape":"string", + "documentation":"The bundle ID to use for the distribution.
A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.
Use the GetDistributionBundles
action to get a list of distribution bundle IDs that you can specify.
The tag keys and optional values to add to the distribution during create.
Use the TagResource
action to tag a resource after it's created.
An object that describes the distribution created.
" + }, + "operation":{ + "shape":"Operation", + "documentation":"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.
" + } + } + }, "CreateDomainEntryRequest":{ "type":"structure", "required":[ @@ -3080,7 +3669,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the tag resource
operation.
The tag keys and optional values to add to the resource during create.
Use the TagResource
action to tag a resource after it's created.
The name of the certificate to delete.
Use the GetCertificates
action to get a list of certificate names that you can specify.
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.
" + } + } + }, "DeleteContactMethodRequest":{ "type":"structure", "required":["protocol"], @@ -3619,6 +4227,24 @@ } } }, + "DeleteDistributionRequest":{ + "type":"structure", + "members":{ + "distributionName":{ + "shape":"ResourceName", + "documentation":"The name of the distribution to delete.
Use the GetDistributions
action to get a list of distribution names that you can specify.
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.
" + } + } + }, "DeleteDomainEntryRequest":{ "type":"structure", "required":[ @@ -3853,6 +4479,25 @@ }, "documentation":"Describes the destination of a record.
" }, + "DetachCertificateFromDistributionRequest":{ + "type":"structure", + "required":["distributionName"], + "members":{ + "distributionName":{ + "shape":"ResourceName", + "documentation":"The name of the distribution from which to detach the certificate.
Use the GetDistributions
action to get a list of distribution names that you can specify.
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.
" + } + } + }, "DetachDiskRequest":{ "type":"structure", "required":["diskName"], @@ -4166,6 +4811,51 @@ "unknown" ] }, + "DistributionBundle":{ + "type":"structure", + "members":{ + "bundleId":{ + "shape":"string", + "documentation":"The ID of the bundle.
" + }, + "name":{ + "shape":"string", + "documentation":"The name of the distribution bundle.
" + }, + "price":{ + "shape":"float", + "documentation":"The monthly price, in US dollars, of the bundle.
" + }, + "transferPerMonthInGb":{ + "shape":"integer", + "documentation":"The monthly network transfer quota of the bundle.
" + }, + "isActive":{ + "shape":"boolean", + "documentation":"Indicates whether the bundle is active, and can be specified for a new distribution.
" + } + }, + "documentation":"Describes the specifications of a distribution bundle.
" + }, + "DistributionBundleList":{ + "type":"list", + "member":{"shape":"DistributionBundle"} + }, + "DistributionList":{ + "type":"list", + "member":{"shape":"LightsailDistribution"} + }, + "DistributionMetricName":{ + "type":"string", + "enum":[ + "Requests", + "BytesDownloaded", + "BytesUploaded", + "TotalErrorRate", + "Http4xxErrorRate", + "Http5xxErrorRate" + ] + }, "Domain":{ "type":"structure", "members":{ @@ -4255,6 +4945,24 @@ "type":"list", "member":{"shape":"DomainName"} }, + "DomainValidationRecord":{ + "type":"structure", + "members":{ + "domainName":{ + "shape":"DomainName", + "documentation":"The domain name of the certificate validation record. For example, example.com
or www.example.com
.
An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
" + } + }, + "documentation":"Describes the domain validation records of an Amazon Lightsail SSL/TLS certificate.
" + }, + "DomainValidationRecordList":{ + "type":"list", + "member":{"shape":"DomainValidationRecord"} + }, "DownloadDefaultKeyPairRequest":{ "type":"structure", "members":{ @@ -4273,6 +4981,7 @@ } } }, + "EligibleToRenew":{"type":"string"}, "EnableAddOnRequest":{ "type":"structure", "required":[ @@ -4405,6 +5114,14 @@ } } }, + "ForwardValues":{ + "type":"string", + "enum":[ + "none", + "allow-list", + "all" + ] + }, "GetActiveNamesRequest":{ "type":"structure", "members":{ @@ -4536,6 +5253,32 @@ } } }, + "GetCertificatesRequest":{ + "type":"structure", + "members":{ + "certificateStatuses":{ + "shape":"CertificateStatusList", + "documentation":"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.
" + }, + "includeCertificateDetails":{ + "shape":"IncludeCertificateDetails", + "documentation":"Indicates whether to include detailed information about the certificates in the response.
When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.
" + }, + "certificateName":{ + "shape":"CertificateName", + "documentation":"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.
" + } + } + }, + "GetCertificatesResult":{ + "type":"structure", + "members":{ + "certificates":{ + "shape":"CertificateSummaryList", + "documentation":"An object that describes certificates.
" + } + } + }, "GetCloudFormationStackRecordsRequest":{ "type":"structure", "members":{ @@ -4586,75 +5329,192 @@ } } }, - "GetDiskResult":{ + "GetDiskResult":{ + "type":"structure", + "members":{ + "disk":{ + "shape":"Disk", + "documentation":"An object containing information about the disk.
" + } + } + }, + "GetDiskSnapshotRequest":{ + "type":"structure", + "required":["diskSnapshotName"], + "members":{ + "diskSnapshotName":{ + "shape":"ResourceName", + "documentation":"The name of the disk snapshot (e.g., my-disk-snapshot
).
An object containing information about the disk snapshot.
" + } + } + }, + "GetDiskSnapshotsRequest":{ + "type":"structure", + "members":{ + "pageToken":{ + "shape":"string", + "documentation":"The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDiskSnapshots
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.
An array of objects containing information about all block storage disk snapshots.
" + }, + "nextPageToken":{ + "shape":"string", + "documentation":"The token to advance to the next page of resutls 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 GetDiskSnapshots
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 GetDisks
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.
An array of objects containing information about all block storage disks.
" + }, + "nextPageToken":{ + "shape":"string", + "documentation":"The token to advance to the next page of resutls 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 GetDisks
request and specify the next page token using the pageToken
parameter.
An object containing information about the disk.
" + "bundles":{ + "shape":"DistributionBundleList", + "documentation":"An object that describes a distribution bundle.
" } } }, - "GetDiskSnapshotRequest":{ + "GetDistributionLatestCacheResetRequest":{ "type":"structure", - "required":["diskSnapshotName"], "members":{ - "diskSnapshotName":{ + "distributionName":{ "shape":"ResourceName", - "documentation":"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.
" } } }, - "GetDiskSnapshotResult":{ + "GetDistributionLatestCacheResetResult":{ "type":"structure", "members":{ - "diskSnapshot":{ - "shape":"DiskSnapshot", - "documentation":"An object containing information about the disk snapshot.
" + "status":{ + "shape":"string", + "documentation":"The status of the last cache reset.
" + }, + "createTime":{ + "shape":"IsoDate", + "documentation":"The timestamp of the last cache reset (e.g., 1479734909.17
) in Unix time format.
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDiskSnapshots
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 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 metric for which you want to return information.
Valid distribution metric names are listed below, along with the most useful statistics
to include in your request, and the published unit
value.
Requests
- The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is None
.
BytesDownloaded
- The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is None
.
BytesUploaded
- The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is None
.
TotalErrorRate
- The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.
Statistics
: The most useful statistic is Average
.
Unit
: The published unit is Percent
.
4xxErrorRate
- The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.
Statistics
: The most useful statistic is Average
.
Unit
: The published unit is Percent
.
5xxErrorRate
- The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.
Statistics
: The most useful statistic is Average
.
Unit
: The published unit is Percent
.
The start of the time interval for which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000
as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
" + }, + "endTime":{ + "shape":"timestamp", + "documentation":"The end of the time interval for which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600
as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
" + }, + "period":{ + "shape":"MetricPeriod", + "documentation":"The granularity, in seconds, for the metric data points that will be returned.
" + }, + "unit":{ + "shape":"MetricUnit", + "documentation":"The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName
parameter.
The statistic for the metric.
The following statistics are available:
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount
- The count, or number, of data points used for the statistical calculation.
An array of objects containing information about all block storage disk snapshots.
" + "metricName":{ + "shape":"DistributionMetricName", + "documentation":"The name of the metric returned.
" }, - "nextPageToken":{ - "shape":"string", - "documentation":"The token to advance to the next page of resutls 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 GetDiskSnapshots
request and specify the next page token using the pageToken
parameter.
An array of objects that describe the metric data returned.
" } } }, - "GetDisksRequest":{ + "GetDistributionsRequest":{ "type":"structure", "members":{ + "distributionName":{ + "shape":"ResourceName", + "documentation":"The name of the distribution for which to return information.
Use the GetDistributions
action to get a list of distribution names that you can specify.
When omitted, the response includes all of your distributions in the AWS Region where the request is made.
" + }, "pageToken":{ "shape":"string", - "documentation":"The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDisks
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.
To get a page token, perform an initial GetDistributions
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.
An array of objects containing information about all block storage disks.
" + "distributions":{ + "shape":"DistributionList", + "documentation":"An array of objects that describe your distributions.
" }, "nextPageToken":{ "shape":"string", - "documentation":"The token to advance to the next page of resutls 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 GetDisks
request and specify the next page token using the pageToken
parameter.
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 GetDistributions
request and specify the next page token using the pageToken
parameter.
The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
all
- Forward all headers to your origin.
none
- Forward only the default headers.
allow-list
- Forward only the headers you specify using the headersAllowList
parameter.
The specific headers to forward to your distribution's origin.
" + } + }, + "documentation":"Describes the request headers that a Lightsail distribution bases caching on.
For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg
contain a custom product
header that has a value of either acme
or apex
, and you configure your distribution to cache your content based on values in the product
header. Your distribution forwards the product
header to the origin and caches the response from the origin once for each header value.
The name of the origin resource.
" + }, + "regionName":{ + "shape":"RegionName", + "documentation":"The AWS Region name of the origin resource.
" + }, + "protocolPolicy":{ + "shape":"OriginProtocolPolicyEnum", + "documentation":"The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
" + } + }, + "documentation":"Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.
An origin can be a Lightsail instance or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.
" + }, "Instance":{ "type":"structure", "members":{ @@ -5627,7 +6545,7 @@ }, "createdAt":{ "shape":"IsoDate", - "documentation":"The timestamp when the instance was created (e.g., 1479734909.17
).
The timestamp when the instance was created (e.g., 1479734909.17
) in Unix time format.
The name of the distribution.
" + }, + "arn":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Resource Name (ARN) of the distribution.
" + }, + "supportCode":{ + "shape":"string", + "documentation":"The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"The timestamp when the distribution was created.
" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"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.
The Lightsail resource type (e.g., Distribution
).
The alternate domain names of the distribution.
" + }, + "status":{ + "shape":"string", + "documentation":"The status of the distribution.
" + }, + "isEnabled":{ + "shape":"boolean", + "documentation":"Indicates whether the distribution is enabled.
" + }, + "domainName":{ + "shape":"string", + "documentation":"The domain name of the distribution.
" + }, + "bundleId":{ + "shape":"string", + "documentation":"The ID of the bundle currently applied to the distribution.
" + }, + "certificateName":{ + "shape":"ResourceName", + "documentation":"The name of the SSL/TLS certificate attached to the distribution, if any.
" + }, + "origin":{ + "shape":"Origin", + "documentation":"An object that describes the origin resource of the distribution, such as a Lightsail instance or load balancer.
The distribution pulls, caches, and serves content from the origin.
" + }, + "originPublicDNS":{ + "shape":"string", + "documentation":"The public DNS of the origin.
" + }, + "defaultCacheBehavior":{ + "shape":"CacheBehavior", + "documentation":"An object that describes the default cache behavior of the distribution.
" + }, + "cacheBehaviorSettings":{ + "shape":"CacheSettings", + "documentation":"An object that describes the cache behavior settings of the distribution.
" + }, + "cacheBehaviors":{ + "shape":"CacheBehaviorList", + "documentation":"An array of objects that describe the per-path cache behavior of the distribution.
" + }, + "ableToUpdateBundle":{ + "shape":"boolean", + "documentation":"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.
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
" + } + }, + "documentation":"Describes an Amazon Lightsail content delivery network (CDN) distribution.
" + }, "LoadBalancer":{ "type":"structure", "members":{ @@ -6338,7 +7340,7 @@ }, "failureReason":{ "shape":"LoadBalancerTlsCertificateFailureReason", - "documentation":"The reason for the SSL/TLS certificate validation failure.
" + "documentation":"The validation failure reason, if any, of the certificate.
The following failure reasons are possible:
NO_AVAILABLE_CONTACTS
- This failure applies to email validation, which is not available for Lightsail certificates.
ADDITIONAL_VERIFICATION_REQUIRED
- Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.
You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
DOMAIN_NOT_ALLOWED
- One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.
If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.
If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.
INVALID_PUBLIC_DOMAIN
- One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain
because invalidpublicdomain
is not a valid top-level domain.
OTHER
- Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
The algorithm that was used to generate the key pair (the public and private key).
" + "documentation":"The algorithm used to generate the key pair (the public and private key).
" }, "notAfter":{ "shape":"IsoDate", @@ -6362,15 +7364,15 @@ }, "renewalSummary":{ "shape":"LoadBalancerTlsCertificateRenewalSummary", - "documentation":"An object containing information about the status of Lightsail's managed renewal for the certificate.
" + "documentation":"An object that describes the status of the certificate renewal managed by Lightsail.
" }, "revocationReason":{ "shape":"LoadBalancerTlsCertificateRevocationReason", - "documentation":"The reason the certificate was revoked. Valid values are below.
" + "documentation":"The reason the certificate was revoked. This value is present only when the certificate status is REVOKED
.
The timestamp when the SSL/TLS certificate was revoked.
" + "documentation":"The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED
.
One or more domains or subdomains included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com
, www.example.com
, or m.example.com
.
An array of strings that specify the alternate domains (e.g., example2.com
) and subdomains (e.g., blog.example.com
) for the certificate.
Describes a load balancer SSL/TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
" @@ -6475,14 +7477,14 @@ "members":{ "renewalStatus":{ "shape":"LoadBalancerTlsCertificateRenewalStatus", - "documentation":"The status of Lightsail's managed renewal of the certificate. Valid values are listed below.
" + "documentation":"The renewal status of the certificate.
The following renewal status are possible:
PendingAutoRenewal
- Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.
PendingValidation
- Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.
Success
- All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.
Failed
- One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate
action.
Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.
" } }, - "documentation":"Contains information about the status of Lightsail's managed renewal for the certificate.
" + "documentation":"Contains information about the status of Lightsail's managed renewal for the certificate.
The renewal status of the certificate.
The following renewal status are possible:
PendingAutoRenewal
- Lightsail is attempting to automatically validate the domain names in the certificate. No further action is required.
PendingValidation
- Lightsail couldn't automatically validate one or more domain names in the certificate. You must take action to validate these domain names or the certificate won't be renewed. If you used DNS validation, check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.
Success
- All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.
Failed
- One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate
action.
The name of the origin resource.
" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"The resource type of the origin resource (e.g., Instance).
" + }, + "regionName":{ + "shape":"RegionName", + "documentation":"The AWS Region name of the origin resource.
" + }, + "protocolPolicy":{ + "shape":"OriginProtocolPolicyEnum", + "documentation":"The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
" + } + }, + "documentation":"Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.
An origin can be a Lightsail instance or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.
" + }, + "OriginProtocolPolicyEnum":{ + "type":"string", + "enum":[ + "http-only", + "https-only" ] }, "PasswordData":{ @@ -7110,6 +8150,20 @@ } } }, + "QueryStringObject":{ + "type":"structure", + "members":{ + "option":{ + "shape":"boolean", + "documentation":"Indicates whether the distribution forwards and caches based on query strings.
" + }, + "queryStringsAllowList":{ + "shape":"StringList", + "documentation":"The specific query strings that the distribution forwards to the origin.
Your distribution will cache content based on the specified query strings.
If the option
parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList
parameter.
Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.
For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.
" + }, "RebootInstanceRequest":{ "type":"structure", "required":["instanceName"], @@ -7615,6 +8669,65 @@ } } }, + "RenewalStatus":{ + "type":"string", + "enum":[ + "PendingAutoRenewal", + "PendingValidation", + "Success", + "Failed" + ] + }, + "RenewalStatusReason":{"type":"string"}, + "RenewalSummary":{ + "type":"structure", + "members":{ + "domainValidationRecords":{ + "shape":"DomainValidationRecordList", + "documentation":"An array of objects that describe the domain validation records of the certificate.
" + }, + "renewalStatus":{ + "shape":"RenewalStatus", + "documentation":"The renewal status of the certificate.
The following renewal status are possible:
PendingAutoRenewal
- Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.
PendingValidation
- Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.
Success
- All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.
Failed
- One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate
action.
The reason for the renewal status of the certificate.
" + }, + "updatedAt":{ + "shape":"IsoDate", + "documentation":"The timestamp when the certificate was last updated.
" + } + }, + "documentation":"Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.
" + }, + "RequestFailureReason":{"type":"string"}, + "ResetDistributionCacheRequest":{ + "type":"structure", + "members":{ + "distributionName":{ + "shape":"ResourceName", + "documentation":"The name of the distribution for which to reset cache.
Use the GetDistributions
action to get a list of distribution names that you can specify.
The status of the reset cache request.
" + }, + "createTime":{ + "shape":"IsoDate", + "documentation":"The timestamp of the reset cache request (e.g., 1479734909.17
) in Unix time format.
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.
" + } + } + }, "ResourceArn":{ "type":"string", "pattern":"^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$" @@ -7641,6 +8754,24 @@ "type":"list", "member":{"shape":"ResourceName"} }, + "ResourceRecord":{ + "type":"structure", + "members":{ + "name":{ + "shape":"string", + "documentation":"The name of the record.
" + }, + "type":{ + "shape":"string", + "documentation":"The DNS record type.
" + }, + "value":{ + "shape":"string", + "documentation":"The value for the DNS record.
" + } + }, + "documentation":"Describes the domain name system (DNS) records to add to your domain's DNS to validate it for an Amazon Lightsail certificate.
" + }, "ResourceType":{ "type":"string", "enum":[ @@ -7659,9 +8790,12 @@ "ExportSnapshotRecord", "CloudFormationStackRecord", "Alarm", - "ContactMethod" + "ContactMethod", + "Distribution", + "Certificate" ] }, + "RevocationReason":{"type":"string"}, "SendContactMethodVerificationRequest":{ "type":"structure", "required":["protocol"], @@ -7685,6 +8819,7 @@ "type":"string", "sensitive":true }, + "SerialNumber":{"type":"string"}, "ServiceException":{ "type":"structure", "members":{ @@ -7836,6 +8971,10 @@ "max":256, "min":1 }, + "SubjectAlternativeNameList":{ + "type":"list", + "member":{"shape":"DomainName"} + }, "Tag":{ "type":"structure", "members":{ @@ -7984,6 +9123,64 @@ } } }, + "UpdateDistributionBundleRequest":{ + "type":"structure", + "members":{ + "distributionName":{ + "shape":"ResourceName", + "documentation":"The name of the distribution for which to update the bundle.
Use the GetDistributions
action to get a list of distribution names that you can specify.
The bundle ID of the new bundle to apply to your distribution.
Use the GetDistributionBundles
action to get a list of distribution bundle IDs that you can specify.
The name of the distribution to update.
Use the GetDistributions
action to get a list of distribution names that you can specify.
An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.
The distribution pulls, caches, and serves content from the origin.
" + }, + "defaultCacheBehavior":{ + "shape":"CacheBehavior", + "documentation":"An object that describes the default cache behavior for the distribution.
" + }, + "cacheBehaviorSettings":{ + "shape":"CacheSettings", + "documentation":"An object that describes the cache behavior settings for the distribution.
The cacheBehaviorSettings
specified in your UpdateDistributionRequest
will replace your distribution's existing settings.
An array of objects that describe the per-path cache behavior for the distribution.
" + }, + "isEnabled":{ + "shape":"boolean", + "documentation":"Indicates whether to enable the distribution.
" + } + } + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "operation":{ + "shape":"Operation", + "documentation":"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.
" + } + } + }, "UpdateDomainEntryRequest":{ "type":"structure", "required":[ @@ -8126,8 +9323,9 @@ "double":{"type":"double"}, "float":{"type":"float"}, "integer":{"type":"integer"}, + "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, - "documentation":"Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, a managed database, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
" + "documentation":"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), managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and 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 Lightsail Dev 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 for the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the AWS General Reference.
" } diff --git a/services/machinelearning/pom.xml b/services/machinelearning/pom.xml index ad92465f5957..0c427fa62bb8 100644 --- a/services/machinelearning/pom.xml +++ b/services/machinelearning/pom.xml @@ -21,7 +21,7 @@Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and un-share the image if it is shared with other accounts.
" + "documentation":"Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
" }, "DeregisterWorkspaceDirectory":{ "name":"DeregisterWorkspaceDirectory", @@ -268,6 +268,21 @@ ], "documentation":"Describes the available directories that are registered with Amazon WorkSpaces.
" }, + "DescribeWorkspaceImagePermissions":{ + "name":"DescribeWorkspaceImagePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceImagePermissionsRequest"}, + "output":{"shape":"DescribeWorkspaceImagePermissionsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
" + }, "DescribeWorkspaceImages":{ "name":"DescribeWorkspaceImages", "http":{ @@ -482,7 +497,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ResourceUnavailableException"} ], - "documentation":"Modifies the specified WorkSpace properties.
" + "documentation":"Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
" }, "ModifyWorkspaceState":{ "name":"ModifyWorkspaceState", @@ -517,7 +532,7 @@ }, "input":{"shape":"RebuildWorkspacesRequest"}, "output":{"shape":"RebuildWorkspacesResult"}, - "documentation":"Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
, UNHEALTHY
, or STOPPED
.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
" + "documentation":"Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
, UNHEALTHY
, STOPPED
, or REBOOTING
.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
" }, "RegisterWorkspaceDirectory":{ "name":"RegisterWorkspaceDirectory", @@ -616,6 +631,23 @@ {"shape":"AccessDeniedException"} ], "documentation":"Replaces the current rules of the specified IP access control group with the specified rules.
" + }, + "UpdateWorkspaceImagePermission":{ + "name":"UpdateWorkspaceImagePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWorkspaceImagePermissionRequest"}, + "output":{"shape":"UpdateWorkspaceImagePermissionResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"Shares or unshares an image with one account by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
The identifier of any security groups to apply to WorkSpaces when they are created.
" + "documentation":"The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
" }, "UserEnabledAsLocalAdministrator":{ "shape":"BooleanObject", @@ -1200,6 +1236,41 @@ } } }, + "DescribeWorkspaceImagePermissionsRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
The maximum number of items to return.
" + } + } + }, + "DescribeWorkspaceImagePermissionsResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "ImagePermissions":{ + "shape":"ImagePermissions", + "documentation":"The identifiers of the AWS accounts that the image has been shared with.
" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use to retrieve the next set of results, or null if no more results are available.
" + } + } + }, "DescribeWorkspaceImagesRequest":{ "type":"structure", "members":{ @@ -1207,6 +1278,10 @@ "shape":"WorkspaceImageIdList", "documentation":"The identifier of the image.
" }, + "ImageType":{ + "shape":"ImageType", + "documentation":"The type (owned or shared) of the image.
" + }, "NextToken":{ "shape":"PaginationToken", "documentation":"If you received a NextToken
from a previous call that was paginated, provide this token to receive the next set of results.
Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
" }, + "ImagePermission":{ + "type":"structure", + "members":{ + "SharedAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the AWS account that an image has been shared with.
" + } + }, + "documentation":"Describes the AWS accounts that have been granted permission to use a shared image.
" + }, + "ImagePermissions":{ + "type":"list", + "member":{"shape":"ImagePermission"} + }, + "ImageType":{ + "type":"string", + "enum":[ + "OWNED", + "SHARED" + ] + }, "ImportWorkspaceImageRequest":{ "type":"structure", "required":[ @@ -2328,6 +2424,33 @@ "members":{ } }, + "UpdateWorkspaceImagePermissionRequest":{ + "type":"structure", + "required":[ + "ImageId", + "AllowCopyImage", + "SharedAccountId" + ], + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"The identifier of the image.
" + }, + "AllowCopyImage":{ + "shape":"BooleanObject", + "documentation":"The permission to copy the image. This permission can be revoked only after an image has been shared.
" + }, + "SharedAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the AWS account to share or unshare the image with.
" + } + } + }, + "UpdateWorkspaceImagePermissionResult":{ + "type":"structure", + "members":{ + } + }, "UserName":{ "type":"string", "max":63, @@ -2671,6 +2794,14 @@ "ErrorMessage":{ "shape":"Description", "documentation":"The text of the error message that is returned for the image.
" + }, + "Created":{ + "shape":"Timestamp", + "documentation":"The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image.
" + }, + "OwnerAccountId":{ + "shape":"AwsAccount", + "documentation":"The identifier of the AWS account that owns the image.
" } }, "documentation":"Describes a WorkSpace image.
" @@ -2742,11 +2873,11 @@ }, "RootVolumeSizeGib":{ "shape":"RootVolumeSizeGib", - "documentation":"The size of the root volume.
" + "documentation":"The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
" }, "UserVolumeSizeGib":{ "shape":"UserVolumeSizeGib", - "documentation":"The size of the user storage.
" + "documentation":"The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
" }, "ComputeTypeName":{ "shape":"Compute", diff --git a/services/xray/pom.xml b/services/xray/pom.xml index ae6bce49bf52..c53503b2b470 100644 --- a/services/xray/pom.xml +++ b/services/xray/pom.xml @@ -21,7 +21,7 @@