{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.cloudhsmv2#Backup": { "type": "structure", "members": { "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "
The identifier (ID) of the backup.
", "smithy.api#required": {} } }, "BackupState": { "target": "com.amazonaws.cloudhsmv2#BackupState", "traits": { "smithy.api#documentation": "The state of the backup.
" } }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster that was backed up.
" } }, "CreateTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the backup was created.
" } }, "CopyTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the backup was copied from a source backup.
" } }, "NeverExpires": { "target": "com.amazonaws.cloudhsmv2#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the service should exempt a backup from the retention policy for the cluster. True
exempts \n a backup from the retention policy. False
means the service applies the backup retention policy defined at the cluster.
The AWS Region that contains the source backup from which the new backup was\n copied.
" } }, "SourceBackup": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "The identifier (ID) of the source backup from which the new backup was\n copied.
" } }, "SourceCluster": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster containing the source backup from which the new\n backup was copied.
" } }, "DeleteTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the backup will be permanently deleted.
" } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "The list of tags for the backup.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a backup of an AWS CloudHSM cluster. All backup objects\n contain the BackupId
, BackupState
, ClusterId
, and\n CreateTimestamp
parameters. Backups that were copied into a destination region\n additionally contain the CopyTimestamp
, SourceBackup
,\n SourceCluster
, and SourceRegion
parameters. A backup that is\n pending deletion will include the DeleteTimestamp
parameter.
The type of backup retention policy. For the DAYS
type, the value is \n the number of days to retain backups.
Use a value between 7 - 379.
" } } }, "traits": { "smithy.api#documentation": "A policy that defines the number of days to retain backups.
" } }, "com.amazonaws.cloudhsmv2#BackupRetentionType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DAYS", "name": "DAYS" } ] } }, "com.amazonaws.cloudhsmv2#BackupRetentionValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 3 }, "smithy.api#pattern": "[0-9]+" } }, "com.amazonaws.cloudhsmv2#BackupState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", "name": "CREATE_IN_PROGRESS" }, { "value": "READY", "name": "READY" }, { "value": "DELETED", "name": "DELETED" }, { "value": "PENDING_DELETION", "name": "PENDING_DELETION" } ] } }, "com.amazonaws.cloudhsmv2#Backups": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#Backup" } }, "com.amazonaws.cloudhsmv2#BackupsMaxSize": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudhsmv2#BaldrApiService": { "type": "service", "version": "2017-04-28", "operations": [ { "target": "com.amazonaws.cloudhsmv2#CopyBackupToRegion" }, { "target": "com.amazonaws.cloudhsmv2#CreateCluster" }, { "target": "com.amazonaws.cloudhsmv2#CreateHsm" }, { "target": "com.amazonaws.cloudhsmv2#DeleteBackup" }, { "target": "com.amazonaws.cloudhsmv2#DeleteCluster" }, { "target": "com.amazonaws.cloudhsmv2#DeleteHsm" }, { "target": "com.amazonaws.cloudhsmv2#DescribeBackups" }, { "target": "com.amazonaws.cloudhsmv2#DescribeClusters" }, { "target": "com.amazonaws.cloudhsmv2#InitializeCluster" }, { "target": "com.amazonaws.cloudhsmv2#ListTags" }, { "target": "com.amazonaws.cloudhsmv2#ModifyBackupAttributes" }, { "target": "com.amazonaws.cloudhsmv2#ModifyCluster" }, { "target": "com.amazonaws.cloudhsmv2#RestoreBackup" }, { "target": "com.amazonaws.cloudhsmv2#TagResource" }, { "target": "com.amazonaws.cloudhsmv2#UntagResource" } ], "traits": { "aws.api#service": { "sdkId": "CloudHSM V2", "arnNamespace": "cloudhsm", "cloudFormationName": "CloudHSMV2", "cloudTrailEventSource": "cloudhsmv2.amazonaws.com", "endpointPrefix": "cloudhsmv2" }, "aws.auth#sigv4": { "name": "cloudhsm" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "For more information about AWS CloudHSM, see AWS CloudHSM and the AWS\n CloudHSM User Guide.
", "smithy.api#title": "AWS CloudHSM V2" } }, "com.amazonaws.cloudhsmv2#Boolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudhsmv2#Cert": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 5000 }, "smithy.api#pattern": "[a-zA-Z0-9+-/=\\s]*" } }, "com.amazonaws.cloudhsmv2#Certificates": { "type": "structure", "members": { "ClusterCsr": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "The cluster's certificate signing request (CSR). The CSR exists only when the cluster's\n state is UNINITIALIZED
.
The HSM certificate issued (signed) by the HSM hardware.
" } }, "AwsHardwareCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "The HSM hardware certificate issued (signed) by AWS CloudHSM.
" } }, "ManufacturerHardwareCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "The HSM hardware certificate issued (signed) by the hardware manufacturer.
" } }, "ClusterCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "The cluster certificate issued (signed) by the issuing certificate authority (CA) of\n the cluster's owner.
" } } }, "traits": { "smithy.api#documentation": "Contains one or more certificates or a certificate signing request (CSR).
" } }, "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the requester does not have permission to perform the\n requested operation.
", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because of an AWS CloudHSM internal failure. The request can\n be retried.
", "smithy.api#error": "server" } }, "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because it is not a valid request.
", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because it refers to a resource that cannot be\n found.
", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because an error occurred.
", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#CloudHsmTagException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudhsmv2#errorMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
", "smithy.api#error": "client" } }, "com.amazonaws.cloudhsmv2#Cluster": { "type": "structure", "members": { "BackupPolicy": { "target": "com.amazonaws.cloudhsmv2#BackupPolicy", "traits": { "smithy.api#documentation": "The cluster's backup policy.
" } }, "BackupRetentionPolicy": { "target": "com.amazonaws.cloudhsmv2#BackupRetentionPolicy", "traits": { "smithy.api#documentation": "A policy that defines how the service retains backups.
" } }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The cluster's identifier (ID).
" } }, "CreateTimestamp": { "target": "com.amazonaws.cloudhsmv2#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the cluster was created.
" } }, "Hsms": { "target": "com.amazonaws.cloudhsmv2#Hsms", "traits": { "smithy.api#documentation": "Contains information about the HSMs in the cluster.
" } }, "HsmType": { "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { "smithy.api#documentation": "The type of HSM that the cluster contains.
" } }, "PreCoPassword": { "target": "com.amazonaws.cloudhsmv2#PreCoPassword", "traits": { "smithy.api#documentation": "The default password for the cluster's Pre-Crypto Officer (PRECO) user.
" } }, "SecurityGroup": { "target": "com.amazonaws.cloudhsmv2#SecurityGroup", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster's security group.
" } }, "SourceBackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "The identifier (ID) of the backup used to create the cluster. This value exists only\n when the cluster was created from a backup.
" } }, "State": { "target": "com.amazonaws.cloudhsmv2#ClusterState", "traits": { "smithy.api#documentation": "The cluster's state.
" } }, "StateMessage": { "target": "com.amazonaws.cloudhsmv2#StateMessage", "traits": { "smithy.api#documentation": "A description of the cluster's state.
" } }, "SubnetMapping": { "target": "com.amazonaws.cloudhsmv2#ExternalSubnetMapping", "traits": { "smithy.api#documentation": "A map from availability zone to the cluster’s subnet in that availability zone.
" } }, "VpcId": { "target": "com.amazonaws.cloudhsmv2#VpcId", "traits": { "smithy.api#documentation": "The identifier (ID) of the virtual private cloud (VPC) that contains the\n cluster.
" } }, "Certificates": { "target": "com.amazonaws.cloudhsmv2#Certificates", "traits": { "smithy.api#documentation": "Contains one or more certificates or a certificate signing request (CSR).
" } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "The list of tags for the cluster.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an AWS CloudHSM cluster.
" } }, "com.amazonaws.cloudhsmv2#ClusterId": { "type": "string", "traits": { "smithy.api#pattern": "cluster-[2-7a-zA-Z]{11,16}" } }, "com.amazonaws.cloudhsmv2#ClusterState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", "name": "CREATE_IN_PROGRESS" }, { "value": "UNINITIALIZED", "name": "UNINITIALIZED" }, { "value": "INITIALIZE_IN_PROGRESS", "name": "INITIALIZE_IN_PROGRESS" }, { "value": "INITIALIZED", "name": "INITIALIZED" }, { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "UPDATE_IN_PROGRESS", "name": "UPDATE_IN_PROGRESS" }, { "value": "DELETE_IN_PROGRESS", "name": "DELETE_IN_PROGRESS" }, { "value": "DELETED", "name": "DELETED" }, { "value": "DEGRADED", "name": "DEGRADED" } ] } }, "com.amazonaws.cloudhsmv2#Clusters": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#Cluster" } }, "com.amazonaws.cloudhsmv2#ClustersMaxSize": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 25 } } }, "com.amazonaws.cloudhsmv2#CopyBackupToRegion": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#CopyBackupToRegionRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#CopyBackupToRegionResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "Copy an AWS CloudHSM cluster backup to a different region.
" } }, "com.amazonaws.cloudhsmv2#CopyBackupToRegionRequest": { "type": "structure", "members": { "DestinationRegion": { "target": "com.amazonaws.cloudhsmv2#Region", "traits": { "smithy.api#documentation": "The AWS region that will contain your copied CloudHSM cluster backup.
", "smithy.api#required": {} } }, "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "The ID of the backup that will be copied to the destination region.
", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.
" } } } }, "com.amazonaws.cloudhsmv2#CopyBackupToRegionResponse": { "type": "structure", "members": { "DestinationBackup": { "target": "com.amazonaws.cloudhsmv2#DestinationBackup", "traits": { "smithy.api#documentation": "Information on the backup that will be copied to the destination region, including\n CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the\n destination backup will be the same as that of the source backup.
\nYou will need to use the sourceBackupID
returned in this operation to use\n the DescribeBackups operation on the backup that will be copied to the\n destination region.
Creates a new AWS CloudHSM cluster.
" } }, "com.amazonaws.cloudhsmv2#CreateClusterRequest": { "type": "structure", "members": { "BackupRetentionPolicy": { "target": "com.amazonaws.cloudhsmv2#BackupRetentionPolicy", "traits": { "smithy.api#documentation": "A policy that defines how the service retains backups.
" } }, "HsmType": { "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { "smithy.api#documentation": "The type of HSM to use in the cluster. Currently the only allowed value is\n hsm1.medium
.
The identifier (ID) of the cluster backup to restore. Use this value to restore the\n cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.
" } }, "SubnetIds": { "target": "com.amazonaws.cloudhsmv2#SubnetIds", "traits": { "smithy.api#documentation": "The identifiers (IDs) of the subnets where you are creating the cluster. You must\n specify at least one subnet. If you specify multiple subnets, they must meet the following\n criteria:
\nAll subnets must be in the same virtual private cloud (VPC).
\nYou can specify only one subnet per Availability Zone.
\nTags to apply to the CloudHSM cluster during creation.
" } } } }, "com.amazonaws.cloudhsmv2#CreateClusterResponse": { "type": "structure", "members": { "Cluster": { "target": "com.amazonaws.cloudhsmv2#Cluster", "traits": { "smithy.api#documentation": "Information about the cluster that was created.
" } } } }, "com.amazonaws.cloudhsmv2#CreateHsm": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#CreateHsmRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#CreateHsmResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "Creates a new hardware security module (HSM) in the specified AWS CloudHSM\n cluster.
" } }, "com.amazonaws.cloudhsmv2#CreateHsmRequest": { "type": "structure", "members": { "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
", "smithy.api#required": {} } }, "AvailabilityZone": { "target": "com.amazonaws.cloudhsmv2#ExternalAz", "traits": { "smithy.api#documentation": "The Availability Zone where you are creating the HSM. To find the cluster's\n Availability Zones, use DescribeClusters.
", "smithy.api#required": {} } }, "IpAddress": { "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { "smithy.api#documentation": "The HSM's IP address. If you specify an IP address, use an available address from the\n subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify\n an IP address, one is chosen for you from that subnet.
" } } } }, "com.amazonaws.cloudhsmv2#CreateHsmResponse": { "type": "structure", "members": { "Hsm": { "target": "com.amazonaws.cloudhsmv2#Hsm", "traits": { "smithy.api#documentation": "Information about the HSM that was created.
" } } } }, "com.amazonaws.cloudhsmv2#DeleteBackup": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DeleteBackupRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DeleteBackupResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days\n after the DeleteBackup request is made. For more information on restoring a backup, see\n RestoreBackup.
" } }, "com.amazonaws.cloudhsmv2#DeleteBackupRequest": { "type": "structure", "members": { "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudhsmv2#DeleteBackupResponse": { "type": "structure", "members": { "Backup": { "target": "com.amazonaws.cloudhsmv2#Backup", "traits": { "smithy.api#documentation": "Information on the Backup
object deleted.
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must\n delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
" } }, "com.amazonaws.cloudhsmv2#DeleteClusterRequest": { "type": "structure", "members": { "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use\n DescribeClusters.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudhsmv2#DeleteClusterResponse": { "type": "structure", "members": { "Cluster": { "target": "com.amazonaws.cloudhsmv2#Cluster", "traits": { "smithy.api#documentation": "Information about the cluster that was deleted.
" } } } }, "com.amazonaws.cloudhsmv2#DeleteHsm": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DeleteHsmRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DeleteHsmResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP\n address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to\n specify only one of these values. To find these values, use DescribeClusters.
" } }, "com.amazonaws.cloudhsmv2#DeleteHsmRequest": { "type": "structure", "members": { "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster that contains the HSM that you are\n deleting.
", "smithy.api#required": {} } }, "HsmId": { "target": "com.amazonaws.cloudhsmv2#HsmId", "traits": { "smithy.api#documentation": "The identifier (ID) of the HSM that you are deleting.
" } }, "EniId": { "target": "com.amazonaws.cloudhsmv2#EniId", "traits": { "smithy.api#documentation": "The identifier (ID) of the elastic network interface (ENI) of the HSM that you are\n deleting.
" } }, "EniIp": { "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { "smithy.api#documentation": "The IP address of the elastic network interface (ENI) of the HSM that you are\n deleting.
" } } } }, "com.amazonaws.cloudhsmv2#DeleteHsmResponse": { "type": "structure", "members": { "HsmId": { "target": "com.amazonaws.cloudhsmv2#HsmId", "traits": { "smithy.api#documentation": "The identifier (ID) of the HSM that was deleted.
" } } } }, "com.amazonaws.cloudhsmv2#DescribeBackups": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#DescribeBackupsRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#DescribeBackupsResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "Gets information about backups of AWS CloudHSM clusters.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the backups. When the response contains only a subset of backups, it includes a\n NextToken
value. Use this value in a subsequent DescribeBackups
\n request to get more backups. When you receive a response with no NextToken
(or an\n empty or null value), that means there are no more backups to get.
The NextToken
value that you received in the previous response. Use this\n value to get more backups.
The maximum number of backups to return in the response. When there are more backups\n than the number you specify, the response contains a NextToken
value.
One or more filters to limit the items returned in the response.
\nUse the backupIds
filter to return only the specified backups. Specify\n backups by their backup identifier (ID).
Use the sourceBackupIds
filter to return only the backups created from a\n source backup. The sourceBackupID
of a source backup is returned by the CopyBackupToRegion operation.
Use the clusterIds
filter to return only the backups for the specified\n clusters. Specify clusters by their cluster identifier (ID).
Use the states
filter to return only backups that match the specified\n state.
Use the neverExpires
filter to return backups filtered by the value in the\n neverExpires
parameter. True
returns all backups exempt from the\n backup retention policy. False
returns all backups with a backup retention policy\n defined at the cluster.
Designates whether or not to sort the return backups by ascending chronological order\n of generation.
" } } } }, "com.amazonaws.cloudhsmv2#DescribeBackupsResponse": { "type": "structure", "members": { "Backups": { "target": "com.amazonaws.cloudhsmv2#Backups", "traits": { "smithy.api#documentation": "A list of backups.
" } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "An opaque string that indicates that the response contains only a subset of backups.\n Use this value in a subsequent DescribeBackups
request to get more\n backups.
Gets information about AWS CloudHSM clusters.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the clusters. When the response contains only a subset of clusters, it includes\n a NextToken
value. Use this value in a subsequent DescribeClusters
\n request to get more clusters. When you receive a response with no NextToken
(or\n an empty or null value), that means there are no more clusters to get.
One or more filters to limit the items returned in the response.
\nUse the clusterIds
filter to return only the specified clusters. Specify\n clusters by their cluster identifier (ID).
Use the vpcIds
filter to return only the clusters in the specified virtual\n private clouds (VPCs). Specify VPCs by their VPC identifier (ID).
Use the states
filter to return only clusters that match the specified\n state.
The NextToken
value that you received in the previous response. Use this\n value to get more clusters.
The maximum number of clusters to return in the response. When there are more clusters\n than the number you specify, the response contains a NextToken
value.
A list of clusters.
" } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "An opaque string that indicates that the response contains only a subset of clusters.\n Use this value in a subsequent DescribeClusters
request to get more\n clusters.
The date and time when both the source backup was created.
" } }, "SourceRegion": { "target": "com.amazonaws.cloudhsmv2#Region", "traits": { "smithy.api#documentation": "The AWS region that contains the source backup from which the new backup was copied.
" } }, "SourceBackup": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "The identifier (ID) of the source backup from which the new backup was copied.
" } }, "SourceCluster": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.
" } }, "com.amazonaws.cloudhsmv2#EniId": { "type": "string", "traits": { "smithy.api#pattern": "eni-[0-9a-fA-F]{8,17}" } }, "com.amazonaws.cloudhsmv2#ExternalAz": { "type": "string", "traits": { "smithy.api#pattern": "[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d[a-z]" } }, "com.amazonaws.cloudhsmv2#ExternalSubnetMapping": { "type": "map", "key": { "target": "com.amazonaws.cloudhsmv2#ExternalAz" }, "value": { "target": "com.amazonaws.cloudhsmv2#SubnetId" } }, "com.amazonaws.cloudhsmv2#Field": { "type": "string", "traits": { "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.cloudhsmv2#Filters": { "type": "map", "key": { "target": "com.amazonaws.cloudhsmv2#Field" }, "value": { "target": "com.amazonaws.cloudhsmv2#Strings" } }, "com.amazonaws.cloudhsmv2#Hsm": { "type": "structure", "members": { "AvailabilityZone": { "target": "com.amazonaws.cloudhsmv2#ExternalAz", "traits": { "smithy.api#documentation": "The Availability Zone that contains the HSM.
" } }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster that contains the HSM.
" } }, "SubnetId": { "target": "com.amazonaws.cloudhsmv2#SubnetId", "traits": { "smithy.api#documentation": "The subnet that contains the HSM's elastic network interface (ENI).
" } }, "EniId": { "target": "com.amazonaws.cloudhsmv2#EniId", "traits": { "smithy.api#documentation": "The identifier (ID) of the HSM's elastic network interface (ENI).
" } }, "EniIp": { "target": "com.amazonaws.cloudhsmv2#IpAddress", "traits": { "smithy.api#documentation": "The IP address of the HSM's elastic network interface (ENI).
" } }, "HsmId": { "target": "com.amazonaws.cloudhsmv2#HsmId", "traits": { "smithy.api#documentation": "The HSM's identifier (ID).
", "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.cloudhsmv2#HsmState", "traits": { "smithy.api#documentation": "The HSM's state.
" } }, "StateMessage": { "target": "com.amazonaws.cloudhsmv2#String", "traits": { "smithy.api#documentation": "A description of the HSM's state.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a hardware security module (HSM) in an AWS CloudHSM\n cluster.
" } }, "com.amazonaws.cloudhsmv2#HsmId": { "type": "string", "traits": { "smithy.api#pattern": "hsm-[2-7a-zA-Z]{11,16}" } }, "com.amazonaws.cloudhsmv2#HsmState": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", "name": "CREATE_IN_PROGRESS" }, { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "DEGRADED", "name": "DEGRADED" }, { "value": "DELETE_IN_PROGRESS", "name": "DELETE_IN_PROGRESS" }, { "value": "DELETED", "name": "DELETED" } ] } }, "com.amazonaws.cloudhsmv2#HsmType": { "type": "string", "traits": { "smithy.api#pattern": "(hsm1\\.medium)" } }, "com.amazonaws.cloudhsmv2#Hsms": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#Hsm" } }, "com.amazonaws.cloudhsmv2#InitializeCluster": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#InitializeClusterRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#InitializeClusterResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your\n issuing certificate authority (CA) and the CA's root certificate. Before you can claim a\n cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA.\n To get the cluster's CSR, use DescribeClusters.
" } }, "com.amazonaws.cloudhsmv2#InitializeClusterRequest": { "type": "structure", "members": { "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use\n DescribeClusters.
", "smithy.api#required": {} } }, "SignedCert": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "The cluster certificate issued (signed) by your issuing certificate authority (CA). The\n certificate must be in PEM format and can contain a maximum of 5000 characters.
", "smithy.api#required": {} } }, "TrustAnchor": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { "smithy.api#documentation": "The issuing certificate of the issuing certificate authority (CA) that issued (signed)\n the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the\n root certificate. The certificate must be in PEM format and can contain a\n maximum of 5000 characters.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudhsmv2#InitializeClusterResponse": { "type": "structure", "members": { "State": { "target": "com.amazonaws.cloudhsmv2#ClusterState", "traits": { "smithy.api#documentation": "The cluster's state.
" } }, "StateMessage": { "target": "com.amazonaws.cloudhsmv2#StateMessage", "traits": { "smithy.api#documentation": "A description of the cluster's state.
" } } } }, "com.amazonaws.cloudhsmv2#IpAddress": { "type": "string", "traits": { "smithy.api#pattern": "\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}" } }, "com.amazonaws.cloudhsmv2#ListTags": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#ListTagsRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#ListTagsResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "Gets a list of tags for the specified AWS CloudHSM cluster.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the tags. When the response contains only a subset of tags, it includes a\n NextToken
value. Use this value in a subsequent ListTags
request to\n get more tags. When you receive a response with no NextToken
(or an empty or null\n value), that means there are no more tags to get.
The cluster identifier (ID) for the cluster whose tags you are getting. To find the\n cluster ID, use DescribeClusters.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "The NextToken
value that you received in the previous response. Use this\n value to get more tags.
The maximum number of tags to return in the response. When there are more tags than the\n number you specify, the response contains a NextToken
value.
A list of tags.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudhsmv2#NextToken", "traits": { "smithy.api#documentation": "An opaque string that indicates that the response contains only a subset of tags. Use\n this value in a subsequent ListTags
request to get more tags.
Modifies attributes for AWS CloudHSM backup.
" } }, "com.amazonaws.cloudhsmv2#ModifyBackupAttributesRequest": { "type": "structure", "members": { "BackupId": { "target": "com.amazonaws.cloudhsmv2#BackupId", "traits": { "smithy.api#documentation": "The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.
", "smithy.api#required": {} } }, "NeverExpires": { "target": "com.amazonaws.cloudhsmv2#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the service should exempt a backup from the retention policy for the cluster. True
exempts \n a backup from the retention policy. False
means the service applies the backup retention policy defined at the cluster.
Modifies AWS CloudHSM cluster.
" } }, "com.amazonaws.cloudhsmv2#ModifyClusterRequest": { "type": "structure", "members": { "BackupRetentionPolicy": { "target": "com.amazonaws.cloudhsmv2#BackupRetentionPolicy", "traits": { "smithy.api#documentation": "A policy that defines how the service retains backups.
", "smithy.api#required": {} } }, "ClusterId": { "target": "com.amazonaws.cloudhsmv2#ClusterId", "traits": { "smithy.api#documentation": "The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use\n DescribeClusters.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudhsmv2#ModifyClusterResponse": { "type": "structure", "members": { "Cluster": { "target": "com.amazonaws.cloudhsmv2#Cluster" } } }, "com.amazonaws.cloudhsmv2#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.cloudhsmv2#PreCoPassword": { "type": "string", "traits": { "smithy.api#length": { "min": 7, "max": 32 } } }, "com.amazonaws.cloudhsmv2#Region": { "type": "string", "traits": { "smithy.api#pattern": "[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d" } }, "com.amazonaws.cloudhsmv2#ResourceId": { "type": "string", "traits": { "smithy.api#pattern": "(?:cluster|backup)-[2-7a-zA-Z]{11,16}" } }, "com.amazonaws.cloudhsmv2#RestoreBackup": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#RestoreBackupRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#RestoreBackupResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" } ], "traits": { "smithy.api#documentation": "Restores a specified AWS CloudHSM backup that is in the\n PENDING_DELETION
state. For mor information on deleting a backup, see\n DeleteBackup.
The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudhsmv2#RestoreBackupResponse": { "type": "structure", "members": { "Backup": { "target": "com.amazonaws.cloudhsmv2#Backup", "traits": { "smithy.api#documentation": "Information on the Backup
object created.
The key of the tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudhsmv2#TagValue", "traits": { "smithy.api#documentation": "The value of the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains a tag. A tag is a key-value pair.
" } }, "com.amazonaws.cloudhsmv2#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.cloudhsmv2#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudhsmv2#TagList": { "type": "list", "member": { "target": "com.amazonaws.cloudhsmv2#Tag" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.cloudhsmv2#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#TagResourceRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
" } }, "com.amazonaws.cloudhsmv2#TagResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.cloudhsmv2#ResourceId", "traits": { "smithy.api#documentation": "The cluster identifier (ID) for the cluster that you are tagging. To find the cluster\n ID, use DescribeClusters.
", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.cloudhsmv2#TagList", "traits": { "smithy.api#documentation": "A list of one or more tags.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudhsmv2#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.cloudhsmv2#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.cloudhsmv2#Timestamp": { "type": "timestamp" }, "com.amazonaws.cloudhsmv2#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudhsmv2#UntagResourceRequest" }, "output": { "target": "com.amazonaws.cloudhsmv2#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" }, { "target": "com.amazonaws.cloudhsmv2#CloudHsmTagException" } ], "traits": { "smithy.api#documentation": "Removes the specified tag or tags from the specified AWS CloudHSM cluster.
" } }, "com.amazonaws.cloudhsmv2#UntagResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.cloudhsmv2#ResourceId", "traits": { "smithy.api#documentation": "The cluster identifier (ID) for the cluster whose tags you are removing. To find the\n cluster ID, use DescribeClusters.
", "smithy.api#required": {} } }, "TagKeyList": { "target": "com.amazonaws.cloudhsmv2#TagKeyList", "traits": { "smithy.api#documentation": "A list of one or more tag keys for the tags that you are removing. Specify only the tag\n keys, not the tag values.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudhsmv2#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.cloudhsmv2#VpcId": { "type": "string", "traits": { "smithy.api#pattern": "vpc-[0-9a-fA-F]" } }, "com.amazonaws.cloudhsmv2#errorMessage": { "type": "string" } } }