diff --git a/codegen/sdk-codegen/aws-models/backupstorage.json b/codegen/sdk-codegen/aws-models/backupstorage.json new file mode 100644 index 00000000000..d6396719347 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/backupstorage.json @@ -0,0 +1,1376 @@ +{ + "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.backupstorage#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#ServiceErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.backupstorage#BackupObject": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object name", + "smithy.api#required": {} + } + }, + "ChunksCount": { + "target": "com.amazonaws.backupstorage#OptionalLong", + "traits": { + "smithy.api#documentation": "Number of chunks in object" + } + }, + "MetadataString": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Metadata string associated with the Object" + } + }, + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object checksum", + "smithy.api#required": {} + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#required": {} + } + }, + "ObjectToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object token", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Object" + } + }, + "com.amazonaws.backupstorage#Chunk": { + "type": "structure", + "members": { + "Index": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Chunk index", + "smithy.api#required": {} + } + }, + "Length": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Chunk length", + "smithy.api#required": {} + } + }, + "Checksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Chunk checksum", + "smithy.api#required": {} + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#required": {} + } + }, + "ChunkToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Chunk token", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Chunk" + } + }, + "com.amazonaws.backupstorage#ChunkList": { + "type": "list", + "member": { + "target": "com.amazonaws.backupstorage#Chunk" + } + }, + "com.amazonaws.backupstorage#CryoStorageFrontendService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "BackupStorage", + "arnNamespace": "backup-storage", + "cloudFormationName": "BackupStorage", + "cloudTrailEventSource": "backupstorage.amazonaws.com", + "endpointPrefix": "backupstorage" + }, + "aws.auth#sigv4": { + "name": "backup-storage" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "The frontend service for Cryo Storage.", + "smithy.api#title": "AWS Backup Storage" + }, + "version": "2018-04-10", + "operations": [ + { + "target": "com.amazonaws.backupstorage#DeleteObject" + }, + { + "target": "com.amazonaws.backupstorage#GetChunk" + }, + { + "target": "com.amazonaws.backupstorage#GetObjectMetadata" + }, + { + "target": "com.amazonaws.backupstorage#ListChunks" + }, + { + "target": "com.amazonaws.backupstorage#ListObjects" + }, + { + "target": "com.amazonaws.backupstorage#NotifyObjectComplete" + }, + { + "target": "com.amazonaws.backupstorage#PutChunk" + }, + { + "target": "com.amazonaws.backupstorage#PutObject" + }, + { + "target": "com.amazonaws.backupstorage#StartObject" + } + ] + }, + "com.amazonaws.backupstorage#DataAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + }, + "Checksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Data checksum used" + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Checksum algorithm used" + } + } + }, + "traits": { + "smithy.api#documentation": "Non-retryable exception. Attempted to create already existing object or chunk.\n This message contains a checksum of already presented data.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupstorage#DataChecksumAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHA256", + "name": "SHA256" + } + ] + } + }, + "com.amazonaws.backupstorage#DeleteObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#DeleteObjectInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Delete Object from the incremental base Backup.", + "smithy.api#http": { + "method": "DELETE", + "uri": "/backup-jobs/{BackupJobId}/object/{ObjectName}", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#DeleteObjectInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectName": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "The name of the Object.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#GetChunk": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#GetChunkInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#GetChunkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the specified object's chunk.", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{StorageJobId}/chunk/{ChunkToken}", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#GetChunkInput": { + "type": "structure", + "members": { + "StorageJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Storage job id", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChunkToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Chunk token", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#GetChunkOutput": { + "type": "structure", + "members": { + "Data": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Chunk data", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "Length": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Data length", + "smithy.api#httpHeader": "x-amz-data-length", + "smithy.api#required": {} + } + }, + "Checksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Data checksum", + "smithy.api#httpHeader": "x-amz-checksum", + "smithy.api#required": {} + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#httpHeader": "x-amz-checksum-algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#GetObjectMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#GetObjectMetadataInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#GetObjectMetadataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get metadata associated with an Object.", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{StorageJobId}/object/{ObjectToken}/metadata", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#GetObjectMetadataInput": { + "type": "structure", + "members": { + "StorageJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job id for the in-progress backup.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object token.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#GetObjectMetadataOutput": { + "type": "structure", + "members": { + "MetadataString": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Metadata string.", + "smithy.api#httpHeader": "x-amz-metadata-string" + } + }, + "MetadataBlob": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Metadata blob.", + "smithy.api#httpPayload": {} + } + }, + "MetadataBlobLength": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "The size of MetadataBlob.", + "smithy.api#httpHeader": "x-amz-data-length" + } + }, + "MetadataBlobChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "MetadataBlob checksum.", + "smithy.api#httpHeader": "x-amz-checksum" + } + }, + "MetadataBlobChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm.", + "smithy.api#httpHeader": "x-amz-checksum-algorithm" + } + } + } + }, + "com.amazonaws.backupstorage#IllegalArgumentException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Non-retryable exception, indicates client error (wrong argument passed to API).\n See exception message for details.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupstorage#KMSInvalidKeyUsageException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupstorage#ListChunks": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#ListChunksInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#ListChunksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "List chunks in a given Object", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{StorageJobId}/chunks/{ObjectToken}/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backupstorage#ListChunksInput": { + "type": "structure", + "members": { + "StorageJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Storage job id", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object token", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.backupstorage#MaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of chunks", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Pagination token", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.backupstorage#ListChunksOutput": { + "type": "structure", + "members": { + "ChunkList": { + "target": "com.amazonaws.backupstorage#ChunkList", + "traits": { + "smithy.api#documentation": "List of chunks", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Pagination token" + } + } + } + }, + "com.amazonaws.backupstorage#ListObjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#ListObjectsInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#ListObjectsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "List all Objects in a given Backup.", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{StorageJobId}/objects/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backupstorage#ListObjectsInput": { + "type": "structure", + "members": { + "StorageJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Storage job id", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StartingObjectName": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL", + "smithy.api#httpQuery": "starting-object-name" + } + }, + "StartingObjectPrefix": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL", + "smithy.api#httpQuery": "starting-object-prefix" + } + }, + "MaxResults": { + "target": "com.amazonaws.backupstorage#MaxResults", + "traits": { + "smithy.api#documentation": "Maximum objects count", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Pagination token", + "smithy.api#httpQuery": "next-token" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.backupstorage#timestamp", + "traits": { + "smithy.api#documentation": "(Optional) Created before filter", + "smithy.api#httpQuery": "created-before" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.backupstorage#timestamp", + "traits": { + "smithy.api#documentation": "(Optional) Created after filter", + "smithy.api#httpQuery": "created-after" + } + } + } + }, + "com.amazonaws.backupstorage#ListObjectsOutput": { + "type": "structure", + "members": { + "ObjectList": { + "target": "com.amazonaws.backupstorage#ObjectList", + "traits": { + "smithy.api#documentation": "Object list", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Pagination token" + } + } + } + }, + "com.amazonaws.backupstorage#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.backupstorage#MetadataString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^.{1,256}$" + } + }, + "com.amazonaws.backupstorage#NotReadableInputStreamException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.backupstorage#NotifyObjectComplete": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#NotifyObjectCompleteInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#NotifyObjectCompleteOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#NotReadableInputStreamException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "aws.auth#unsignedPayload": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#documentation": "Complete upload", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-jobs/{BackupJobId}/object/{UploadId}/complete", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#NotifyObjectCompleteInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Upload Id for the in-progress upload", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object checksum", + "smithy.api#httpQuery": "checksum", + "smithy.api#required": {} + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#httpQuery": "checksum-algorithm", + "smithy.api#required": {} + } + }, + "MetadataString": { + "target": "com.amazonaws.backupstorage#MetadataString", + "traits": { + "smithy.api#documentation": "Optional metadata associated with an Object. Maximum string length is 256 bytes.", + "smithy.api#httpQuery": "metadata-string" + } + }, + "MetadataBlob": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Optional metadata associated with an Object. Maximum length is 4MB.", + "smithy.api#httpPayload": {} + } + }, + "MetadataBlobLength": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "The size of MetadataBlob.", + "smithy.api#httpQuery": "metadata-blob-length" + } + }, + "MetadataBlobChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Checksum of MetadataBlob.", + "smithy.api#httpQuery": "metadata-checksum" + } + }, + "MetadataBlobChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm.", + "smithy.api#httpQuery": "metadata-checksum-algorithm" + } + } + } + }, + "com.amazonaws.backupstorage#NotifyObjectCompleteOutput": { + "type": "structure", + "members": { + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Object checksum", + "smithy.api#required": {} + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#ObjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.backupstorage#BackupObject" + } + }, + "com.amazonaws.backupstorage#OptionalLong": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.backupstorage#PayloadBlob": { + "type": "blob", + "traits": { + "smithy.api#streaming": {} + } + }, + "com.amazonaws.backupstorage#PutChunk": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#PutChunkInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#PutChunkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#NotReadableInputStreamException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "aws.auth#unsignedPayload": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#documentation": "Upload chunk.", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-jobs/{BackupJobId}/chunk/{UploadId}/{ChunkIndex}", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#PutChunkInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Upload Id for the in-progress upload.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChunkIndex": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Describes this chunk's position relative to the other chunks", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Data": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Data to be uploaded", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "Length": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Data length", + "smithy.api#httpQuery": "length", + "smithy.api#required": {} + } + }, + "Checksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Data checksum", + "smithy.api#httpQuery": "checksum", + "smithy.api#required": {} + } + }, + "ChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#httpQuery": "checksum-algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#PutChunkOutput": { + "type": "structure", + "members": { + "ChunkChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Chunk checksum", + "smithy.api#required": {} + } + }, + "ChunkChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Checksum algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#PutObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#PutObjectInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#PutObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#KMSInvalidKeyUsageException" + }, + { + "target": "com.amazonaws.backupstorage#NotReadableInputStreamException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "aws.auth#unsignedPayload": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], + "smithy.api#documentation": "Upload object that can store object metadata String and data blob in single API call using inline chunk field.", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-jobs/{BackupJobId}/object/{ObjectName}/put-object", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#PutObjectInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectName": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "The name of the Object to be uploaded.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MetadataString": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Store user defined metadata like backup checksum, disk ids, restore metadata etc.", + "smithy.api#httpQuery": "metadata-string" + } + }, + "InlineChunk": { + "target": "com.amazonaws.backupstorage#PayloadBlob", + "traits": { + "smithy.api#documentation": "Inline chunk data to be uploaded.", + "smithy.api#httpPayload": {} + } + }, + "InlineChunkLength": { + "target": "com.amazonaws.backupstorage#long", + "traits": { + "smithy.api#documentation": "Length of the inline chunk data.", + "smithy.api#httpQuery": "length" + } + }, + "InlineChunkChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Inline chunk checksum", + "smithy.api#httpQuery": "checksum" + } + }, + "InlineChunkChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Inline chunk checksum algorithm", + "smithy.api#httpQuery": "checksum-algorithm" + } + }, + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "object checksum", + "smithy.api#httpQuery": "object-checksum" + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "object checksum algorithm", + "smithy.api#httpQuery": "object-checksum-algorithm" + } + }, + "ThrowOnDuplicate": { + "target": "com.amazonaws.backupstorage#boolean", + "traits": { + "smithy.api#documentation": "Throw an exception if Object name is already exist.", + "smithy.api#httpQuery": "throwOnDuplicate" + } + } + } + }, + "com.amazonaws.backupstorage#PutObjectOutput": { + "type": "structure", + "members": { + "InlineChunkChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Inline chunk checksum", + "smithy.api#required": {} + } + }, + "InlineChunkChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#DataChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "Inline chunk checksum algorithm", + "smithy.api#required": {} + } + }, + "ObjectChecksum": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "object checksum", + "smithy.api#required": {} + } + }, + "ObjectChecksumAlgorithm": { + "target": "com.amazonaws.backupstorage#SummaryChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "object checksum algorithm", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Non-retryable exception. Attempted to make an operation on non-existing or expired resource.", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.backupstorage#RetryableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Retryable exception. In general indicates internal failure that can be fixed by retry.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.backupstorage#ServiceErrorMessage": { + "type": "string" + }, + "com.amazonaws.backupstorage#ServiceInternalException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Deprecated. To be removed from the model.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.backupstorage#ServiceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Retryable exception, indicates internal server error.", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.backupstorage#StartObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupstorage#StartObjectInput" + }, + "output": { + "target": "com.amazonaws.backupstorage#StartObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupstorage#DataAlreadyExistsException" + }, + { + "target": "com.amazonaws.backupstorage#IllegalArgumentException" + }, + { + "target": "com.amazonaws.backupstorage#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupstorage#RetryableException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceInternalException" + }, + { + "target": "com.amazonaws.backupstorage#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.backupstorage#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Start upload containing one or many chunks.", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-jobs/{BackupJobId}/object/{ObjectName}", + "code": 200 + } + } + }, + "com.amazonaws.backupstorage#StartObjectInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Backup job Id for the in-progress backup", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectName": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Name for the object.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThrowOnDuplicate": { + "target": "com.amazonaws.backupstorage#boolean", + "traits": { + "smithy.api#documentation": "Throw an exception if Object name is already exist." + } + } + } + }, + "com.amazonaws.backupstorage#StartObjectOutput": { + "type": "structure", + "members": { + "UploadId": { + "target": "com.amazonaws.backupstorage#string", + "traits": { + "smithy.api#documentation": "Upload Id for a given upload.", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupstorage#SummaryChecksumAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUMMARY", + "name": "SUMMARY" + } + ] + } + }, + "com.amazonaws.backupstorage#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.backupstorage#string" + } + }, + "traits": { + "smithy.api#documentation": "Increased rate over throttling limits. Can be retried with exponential backoff.", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.backupstorage#boolean": { + "type": "boolean" + }, + "com.amazonaws.backupstorage#long": { + "type": "long" + }, + "com.amazonaws.backupstorage#string": { + "type": "string" + }, + "com.amazonaws.backupstorage#timestamp": { + "type": "timestamp" + } + } +} diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index 16c3ef1cea3..3e4d26a63a0 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -20202,7 +20202,7 @@ "com.amazonaws.glue#PythonVersionString": { "type": "string", "traits": { - "smithy.api#pattern": "^[2-3]$" + "smithy.api#pattern": "^([2-3]|3[.]9)$" } }, "com.amazonaws.glue#QuerySchemaVersionMetadata": { diff --git a/codegen/sdk-codegen/aws-models/privatenetworks.json b/codegen/sdk-codegen/aws-models/privatenetworks.json new file mode 100644 index 00000000000..1f4ca527ec3 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/privatenetworks.json @@ -0,0 +1,3040 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.privatenetworks#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have permission to perform this operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.privatenetworks#AcknowledgeOrderReceipt": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Acknowledges that the specified network order was received.

", + "smithy.api#http": { + "uri": "/v1/orders/acknowledge", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptRequest": { + "type": "structure", + "members": { + "orderArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptResponse": { + "type": "structure", + "members": { + "order": { + "target": "com.amazonaws.privatenetworks#Order", + "traits": { + "smithy.api#documentation": "

Information about the order.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#AcknowledgmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACKNOWLEDGING", + "name": "ACKNOWLEDGING" + }, + { + "value": "ACKNOWLEDGED", + "name": "ACKNOWLEDGED" + }, + { + "value": "UNACKNOWLEDGED", + "name": "UNACKNOWLEDGED" + } + ] + } + }, + "com.amazonaws.privatenetworks#ActivateDeviceIdentifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifierRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Activates the specified device identifier.

", + "smithy.api#http": { + "uri": "/v1/device-identifiers/activate", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#ActivateDeviceIdentifierRequest": { + "type": "structure", + "members": { + "deviceIdentifierArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ActivateDeviceIdentifierResponse": { + "type": "structure", + "members": { + "deviceIdentifier": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifier", + "traits": { + "smithy.api#documentation": "

Information about the device identifier.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags on the device identifier. \n

" + } + } + } + }, + "com.amazonaws.privatenetworks#ActivateNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ActivateNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ActivateNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Activates the specified network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites/activate", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#ActivateNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#required": {} + } + }, + "shippingAddress": { + "target": "com.amazonaws.privatenetworks#Address", + "traits": { + "smithy.api#documentation": "

The shipping address of the network site.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ActivateNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + } + } + }, + "com.amazonaws.privatenetworks#Address": { + "type": "structure", + "members": { + "city": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The city for this address.

", + "smithy.api#required": {} + } + }, + "company": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The company name for this address.

" + } + }, + "country": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The country for this address.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The recipient's name for this address.

", + "smithy.api#required": {} + } + }, + "phoneNumber": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The phone number for this address.

" + } + }, + "postalCode": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The postal code for this address.

", + "smithy.api#required": {} + } + }, + "stateOrProvince": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The state or province for this address.

", + "smithy.api#required": {} + } + }, + "street1": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The first line of the street address.

", + "smithy.api#required": {} + } + }, + "street2": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The second line of the street address.

" + } + }, + "street3": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

The third line of the street address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an address.

" + } + }, + "com.amazonaws.privatenetworks#AddressContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.privatenetworks#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$" + } + }, + "com.amazonaws.privatenetworks#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.privatenetworks#ConfigureAccessPoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ConfigureAccessPointRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ConfigureAccessPointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Configures the specified network resource. \n

\n

\n Use this action to specify the geographic\n position of the hardware. You must provide Certified Professional Installer (CPI)\n credentials in the request so that we can obtain spectrum grants. For more information,\n see Radio\n units in the Amazon Web Services Private 5G User Guide.

", + "smithy.api#http": { + "uri": "/v1/network-resources/configure", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#ConfigureAccessPointRequest": { + "type": "structure", + "members": { + "accessPointArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

", + "smithy.api#required": {} + } + }, + "position": { + "target": "com.amazonaws.privatenetworks#Position", + "traits": { + "smithy.api#documentation": "

The position of the network resource.

" + } + }, + "cpiUsername": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

The CPI user name of the CPI user who is certifying the coordinates of the radio\n unit.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "cpiUserId": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "cpiUserPassword": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

The CPI password associated with the CPI certificate in\n cpiSecretKey.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "cpiSecretKey": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

A Base64 encoded string of the CPI certificate associated with the CPI user who is\n certifying the coordinates of the network resource.

", + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ConfigureAccessPointResponse": { + "type": "structure", + "members": { + "accessPoint": { + "target": "com.amazonaws.privatenetworks#NetworkResource", + "traits": { + "smithy.api#documentation": "

Information about the network resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#CreateNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#CreateNetworkRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#CreateNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#LimitExceededException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a network.

", + "smithy.api#http": { + "uri": "/v1/networks", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#CreateNetworkRequest": { + "type": "structure", + "members": { + "networkName": { + "target": "com.amazonaws.privatenetworks#Name", + "traits": { + "smithy.api#documentation": "

The name of the network. You can't change the name after you create the network.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.privatenetworks#Description", + "traits": { + "smithy.api#documentation": "

The description of the network.

" + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags to apply to the network.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#CreateNetworkResponse": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.privatenetworks#Network", + "traits": { + "smithy.api#documentation": "

Information about the network.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network tags. \n

" + } + } + } + }, + "com.amazonaws.privatenetworks#CreateNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#CreateNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#CreateNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#CreateNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteName": { + "target": "com.amazonaws.privatenetworks#Name", + "traits": { + "smithy.api#documentation": "

The name of the site. You can't change the name after you create the site.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.privatenetworks#Description", + "traits": { + "smithy.api#documentation": "

The description of the site.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "pendingPlan": { + "target": "com.amazonaws.privatenetworks#SitePlan", + "traits": { + "smithy.api#documentation": "

Information about the pending plan for this site.

" + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + }, + "availabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone that is the parent of this site. You can't change the Availability Zone \n after you create the site.

" + } + }, + "availabilityZoneId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone \n after you create the site.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The tags to apply to the network site.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#CreateNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network site tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#DeactivateDeviceIdentifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deactivates the specified device identifier.

", + "smithy.api#http": { + "uri": "/v1/device-identifiers/deactivate", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierRequest": { + "type": "structure", + "members": { + "deviceIdentifierArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + } + }, + "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierResponse": { + "type": "structure", + "members": { + "deviceIdentifier": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifier", + "traits": { + "smithy.api#documentation": "

Information about the device identifier.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#DeleteNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#DeleteNetworkRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#DeleteNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified network. You must delete network sites before you delete the\n network. For more information, see \n DeleteNetworkSite in the \n API Reference for Amazon Web Services Private 5G.

", + "smithy.api#http": { + "uri": "/v1/networks/{networkArn}", + "method": "DELETE", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkRequest": { + "type": "structure", + "members": { + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", + "smithy.api#httpQuery": "clientToken" + } + } + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkResponse": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.privatenetworks#Network", + "traits": { + "smithy.api#documentation": "

Information about the network.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#DeleteNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#DeleteNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified network site. Return the hardware after you delete the network\n site. You are responsible for minimum charges. For more information, see Hardware\n returns in the Amazon Web Services Private 5G User\n Guide.

", + "smithy.api#http": { + "uri": "/v1/network-sites/{networkSiteArn}", + "method": "DELETE", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", + "smithy.api#httpQuery": "clientToken" + } + } + } + }, + "com.amazonaws.privatenetworks#DeleteNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + } + } + }, + "com.amazonaws.privatenetworks#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifier": { + "type": "structure", + "members": { + "deviceIdentifierArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

" + } + }, + "trafficGroupArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which the device identifier appears.

" + } + }, + "imsi": { + "target": "com.amazonaws.privatenetworks#SensitiveString", + "traits": { + "smithy.api#documentation": "

The International Mobile Subscriber Identity of the device identifier.

", + "smithy.api#pattern": "^[0-9]{15}$" + } + }, + "iccid": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Integrated Circuit Card Identifier of the device identifier.

" + } + }, + "vendor": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The vendor of the device identifier.

" + } + }, + "status": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierStatus", + "traits": { + "smithy.api#documentation": "

The status of the device identifier.

" + } + }, + "orderArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

" + } + }, + "createdAt": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of this device identifier.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a subscriber of a device that can use a network.

" + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATUS", + "value": "STATUS" + }, + { + "name": "ORDER", + "value": "ORDER" + }, + { + "name": "TRAFFIC_GROUP", + "value": "TRAFFIC_GROUP" + } + ] + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilterValues" + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifier" + } + }, + "com.amazonaws.privatenetworks#DeviceIdentifierStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.privatenetworks#E5GNetworkControllerLambda": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "PrivateNetworks", + "arnNamespace": "private-networks" + }, + "aws.auth#sigv4": { + "name": "private-networks" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale\n your own private mobile network at your on-premises location. Private 5G provides the\n pre-configured hardware and software for mobile networks, helps automate setup, and\n scales capacity on demand to support additional devices as needed.

", + "smithy.api#title": "AWS Private 5G" + }, + "version": "2021-12-03", + "operations": [ + { + "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceipt" + }, + { + "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifier" + }, + { + "target": "com.amazonaws.privatenetworks#ActivateNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#ConfigureAccessPoint" + }, + { + "target": "com.amazonaws.privatenetworks#CreateNetwork" + }, + { + "target": "com.amazonaws.privatenetworks#CreateNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifier" + }, + { + "target": "com.amazonaws.privatenetworks#DeleteNetwork" + }, + { + "target": "com.amazonaws.privatenetworks#DeleteNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#GetDeviceIdentifier" + }, + { + "target": "com.amazonaws.privatenetworks#GetNetwork" + }, + { + "target": "com.amazonaws.privatenetworks#GetNetworkResource" + }, + { + "target": "com.amazonaws.privatenetworks#GetNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#GetOrder" + }, + { + "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiers" + }, + { + "target": "com.amazonaws.privatenetworks#ListNetworkResources" + }, + { + "target": "com.amazonaws.privatenetworks#ListNetworks" + }, + { + "target": "com.amazonaws.privatenetworks#ListNetworkSites" + }, + { + "target": "com.amazonaws.privatenetworks#ListOrders" + }, + { + "target": "com.amazonaws.privatenetworks#ListTagsForResource" + }, + { + "target": "com.amazonaws.privatenetworks#Ping" + }, + { + "target": "com.amazonaws.privatenetworks#TagResource" + }, + { + "target": "com.amazonaws.privatenetworks#UntagResource" + }, + { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSite" + }, + { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSitePlan" + } + ] + }, + "com.amazonaws.privatenetworks#ElevationReference": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGL", + "name": "AGL" + }, + { + "value": "AMSL", + "name": "AMSL" + } + ] + } + }, + "com.amazonaws.privatenetworks#ElevationUnit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FEET", + "name": "FEET", + "documentation": "Feet." + } + ] + } + }, + "com.amazonaws.privatenetworks#GetDeviceIdentifier": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetDeviceIdentifierRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetDeviceIdentifierResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified device identifier.

", + "smithy.api#http": { + "uri": "/v1/device-identifiers/{deviceIdentifierArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetDeviceIdentifierRequest": { + "type": "structure", + "members": { + "deviceIdentifierArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetDeviceIdentifierResponse": { + "type": "structure", + "members": { + "deviceIdentifier": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifier", + "traits": { + "smithy.api#documentation": "

Information about the device identifier.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The device identifier tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetNetworkRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified network.

", + "smithy.api#http": { + "uri": "/v1/networks/{networkArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetNetworkRequest": { + "type": "structure", + "members": { + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetNetworkResourceRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetNetworkResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified network resource.

", + "smithy.api#http": { + "uri": "/v1/network-resources/{networkResourceArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetNetworkResourceRequest": { + "type": "structure", + "members": { + "networkResourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkResourceResponse": { + "type": "structure", + "members": { + "networkResource": { + "target": "com.amazonaws.privatenetworks#NetworkResource", + "traits": { + "smithy.api#documentation": "

Information about the network resource.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network resource tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkResponse": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.privatenetworks#Network", + "traits": { + "smithy.api#documentation": "

Information about the network.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites/{networkSiteArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network site tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#GetOrder": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#GetOrderRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#GetOrderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified order.

", + "smithy.api#http": { + "uri": "/v1/orders/{orderArn}", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#GetOrderRequest": { + "type": "structure", + "members": { + "orderArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#GetOrderResponse": { + "type": "structure", + "members": { + "order": { + "target": "com.amazonaws.privatenetworks#Order", + "traits": { + "smithy.api#documentation": "

Information about the order.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The order tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#HealthStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INITIAL", + "name": "INITIAL" + }, + { + "value": "HEALTHY", + "name": "HEALTHY" + }, + { + "value": "UNHEALTHY", + "name": "UNHEALTHY" + } + ] + } + }, + "com.amazonaws.privatenetworks#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.", + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Advice to clients on when the call can be safely retried.", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an internal error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.privatenetworks#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The limit was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.privatenetworks#ListDeviceIdentifiers": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiersRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists device identifiers. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, \n the status of device identifiers, or the ARN of the traffic group.

\n \n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", + "smithy.api#http": { + "uri": "/v1/device-identifiers/list", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "deviceIdentifiers" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListDeviceIdentifiersRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilters", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ListDeviceIdentifiersResponse": { + "type": "structure", + "members": { + "deviceIdentifiers": { + "target": "com.amazonaws.privatenetworks#DeviceIdentifierList", + "traits": { + "smithy.api#documentation": "

Information about the device identifiers.

" + } + }, + "nextToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworkResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListNetworkResourcesRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListNetworkResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists network resources. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or \n the status of network resources.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", + "smithy.api#http": { + "uri": "/v1/network-resources", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networkResources" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListNetworkResourcesRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.privatenetworks#NetworkResourceFilters", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworkResourcesResponse": { + "type": "structure", + "members": { + "networkResources": { + "target": "com.amazonaws.privatenetworks#NetworkResourceList", + "traits": { + "smithy.api#documentation": "

Information about network resources.

" + } + }, + "nextToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworkSites": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListNetworkSitesRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListNetworkSitesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists network sites. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites/list", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networkSites" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListNetworkSitesRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.privatenetworks#NetworkSiteFilters", + "traits": { + "smithy.api#documentation": "

The filters. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network sites.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworkSitesResponse": { + "type": "structure", + "members": { + "networkSites": { + "target": "com.amazonaws.privatenetworks#NetworkSiteList", + "traits": { + "smithy.api#documentation": "

Information about the network sites.

" + } + }, + "nextToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworks": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListNetworksRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListNetworksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists networks. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network.

", + "smithy.api#http": { + "uri": "/v1/networks/list", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "networks" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListNetworksRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.privatenetworks#NetworkFilters", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + } + }, + "com.amazonaws.privatenetworks#ListNetworksResponse": { + "type": "structure", + "members": { + "networks": { + "target": "com.amazonaws.privatenetworks#NetworkList", + "traits": { + "smithy.api#documentation": "

The networks.

" + } + }, + "nextToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListOrders": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListOrdersRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListOrdersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists orders. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or \n the status of the order.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", + "smithy.api#http": { + "uri": "/v1/orders/list", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "startToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "orders" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListOrdersRequest": { + "type": "structure", + "members": { + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "startToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "filters": { + "target": "com.amazonaws.privatenetworks#OrderFilters", + "traits": { + "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListOrdersResponse": { + "type": "structure", + "members": { + "orders": { + "target": "com.amazonaws.privatenetworks#OrderList", + "traits": { + "smithy.api#documentation": "

Information about the orders.

" + } + }, + "nextToken": { + "target": "com.amazonaws.privatenetworks#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.privatenetworks#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#AccessDeniedException" + }, + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ThrottlingException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for the specified resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

The resource tags.

" + } + } + } + }, + "com.amazonaws.privatenetworks#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-]*$" + } + }, + "com.amazonaws.privatenetworks#NameValuePair": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the pair.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value of the pair.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a name/value pair.

" + } + }, + "com.amazonaws.privatenetworks#NameValuePairs": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NameValuePair" + } + }, + "com.amazonaws.privatenetworks#Network": { + "type": "structure", + "members": { + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", + "smithy.api#required": {} + } + }, + "networkName": { + "target": "com.amazonaws.privatenetworks#Name", + "traits": { + "smithy.api#documentation": "

The name of the network.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.privatenetworks#Description", + "traits": { + "smithy.api#documentation": "

The description of the network.

" + } + }, + "status": { + "target": "com.amazonaws.privatenetworks#NetworkStatus", + "traits": { + "smithy.api#documentation": "

The status of the network.

", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status reason of the network.

" + } + }, + "createdAt": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the network.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a network.

" + } + }, + "com.amazonaws.privatenetworks#NetworkFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATUS", + "value": "STATUS" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#NetworkFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#NetworkFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#NetworkFilterValues" + } + }, + "com.amazonaws.privatenetworks#NetworkList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#Network" + } + }, + "com.amazonaws.privatenetworks#NetworkResource": { + "type": "structure", + "members": { + "networkResourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

" + } + }, + "description": { + "target": "com.amazonaws.privatenetworks#Description", + "traits": { + "smithy.api#documentation": "

The description of the network resource.

" + } + }, + "type": { + "target": "com.amazonaws.privatenetworks#NetworkResourceType", + "traits": { + "smithy.api#documentation": "

The type of the network resource.

" + } + }, + "status": { + "target": "com.amazonaws.privatenetworks#NetworkResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the network resource.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status reason of the network resource.

" + } + }, + "vendor": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The vendor of the network resource.

" + } + }, + "model": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The model of the network resource.

" + } + }, + "serialNumber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The serial number of the network resource.

" + } + }, + "health": { + "target": "com.amazonaws.privatenetworks#HealthStatus", + "traits": { + "smithy.api#documentation": "

The health of the network resource.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which this network resource appears.

" + } + }, + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site on which this network resource\n appears.

" + } + }, + "orderArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase this network resource.

" + } + }, + "attributes": { + "target": "com.amazonaws.privatenetworks#NameValuePairs", + "traits": { + "smithy.api#documentation": "

The attributes of the network resource.

" + } + }, + "position": { + "target": "com.amazonaws.privatenetworks#Position", + "traits": { + "smithy.api#documentation": "

The position of the network resource.

" + } + }, + "createdAt": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the network resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a network resource.

" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceDefinition": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitionType", + "traits": { + "smithy.api#documentation": "

The type in the network resource definition.

", + "smithy.api#required": {} + } + }, + "options": { + "target": "com.amazonaws.privatenetworks#Options", + "traits": { + "smithy.api#documentation": "

The options in the network resource definition.

" + } + }, + "count": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The count in the network resource definition.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a network resource definition.

" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceDefinitionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RADIO_UNIT", + "name": "RADIO_UNIT" + }, + { + "value": "DEVICE_IDENTIFIER", + "name": "DEVICE_IDENTIFIER" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkResourceDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NetworkResourceDefinition" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ORDER", + "value": "ORDER" + }, + { + "name": "STATUS", + "value": "STATUS" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkResourceFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#NetworkResourceFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#NetworkResourceFilterValues" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NetworkResource" + } + }, + "com.amazonaws.privatenetworks#NetworkResourceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SHIPPED", + "name": "SHIPPED" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "PROVISIONED", + "name": "PROVISIONED" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "PENDING_RETURN", + "name": "PENDING_RETURN" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RADIO_UNIT", + "name": "RADIO_UNIT" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkSite": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#required": {} + } + }, + "networkSiteName": { + "target": "com.amazonaws.privatenetworks#Name", + "traits": { + "smithy.api#documentation": "

The name of the network site.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.privatenetworks#Description", + "traits": { + "smithy.api#documentation": "

The description of the network site.

" + } + }, + "status": { + "target": "com.amazonaws.privatenetworks#NetworkSiteStatus", + "traits": { + "smithy.api#documentation": "

The status of the network site.

", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status reason of the network site.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network to which the network site belongs.

", + "smithy.api#required": {} + } + }, + "pendingPlan": { + "target": "com.amazonaws.privatenetworks#SitePlan", + "traits": { + "smithy.api#documentation": "

The pending plan of the network site.

" + } + }, + "currentPlan": { + "target": "com.amazonaws.privatenetworks#SitePlan", + "traits": { + "smithy.api#documentation": "

The current plan of the network site.

" + } + }, + "createdAt": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the network site.

" + } + }, + "availabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The parent Availability Zone for the network site.\n

" + } + }, + "availabilityZoneId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The parent Availability Zone ID for the network site.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a network site.

" + } + }, + "com.amazonaws.privatenetworks#NetworkSiteFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATUS", + "value": "STATUS" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkSiteFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#NetworkSiteFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#NetworkSiteFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#NetworkSiteFilterValues" + } + }, + "com.amazonaws.privatenetworks#NetworkSiteList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NetworkSite" + } + }, + "com.amazonaws.privatenetworks#NetworkSiteStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DEPROVISIONING", + "name": "DEPROVISIONING" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.privatenetworks#NetworkStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DEPROVISIONING", + "name": "DEPROVISIONING" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.privatenetworks#Options": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#NameValuePair" + } + }, + "com.amazonaws.privatenetworks#Order": { + "type": "structure", + "members": { + "orderArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

" + } + }, + "shippingAddress": { + "target": "com.amazonaws.privatenetworks#Address", + "traits": { + "smithy.api#documentation": "

The shipping address of the order.

" + } + }, + "networkArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network associated with this order.

" + } + }, + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site associated with this order.

" + } + }, + "trackingInformation": { + "target": "com.amazonaws.privatenetworks#TrackingInformationList", + "traits": { + "smithy.api#documentation": "

The tracking information of the order.

" + } + }, + "acknowledgmentStatus": { + "target": "com.amazonaws.privatenetworks#AcknowledgmentStatus", + "traits": { + "smithy.api#documentation": "

The acknowledgement status of the order.

" + } + }, + "createdAt": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the order.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an order.

" + } + }, + "com.amazonaws.privatenetworks#OrderFilterKeys": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATUS", + "value": "STATUS" + }, + { + "name": "NETWORK_SITE", + "value": "NETWORK_SITE" + } + ] + } + }, + "com.amazonaws.privatenetworks#OrderFilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.privatenetworks#OrderFilters": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#OrderFilterKeys" + }, + "value": { + "target": "com.amazonaws.privatenetworks#OrderFilterValues" + } + }, + "com.amazonaws.privatenetworks#OrderList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#Order" + } + }, + "com.amazonaws.privatenetworks#PaginationToken": { + "type": "string" + }, + "com.amazonaws.privatenetworks#Ping": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.privatenetworks#PingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Checks the health of the service.

", + "smithy.api#http": { + "uri": "/ping", + "method": "GET", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.privatenetworks#PingResponse": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Information about the health of the service.

" + } + } + } + }, + "com.amazonaws.privatenetworks#Position": { + "type": "structure", + "members": { + "latitude": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The latitude of the position.

" + } + }, + "longitude": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The longitude of the position.

" + } + }, + "elevation": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The elevation of the equipment at this position.

" + } + }, + "elevationUnit": { + "target": "com.amazonaws.privatenetworks#ElevationUnit", + "traits": { + "smithy.api#documentation": "

The units used to measure the elevation of the position.

" + } + }, + "elevationReference": { + "target": "com.amazonaws.privatenetworks#ElevationReference", + "traits": { + "smithy.api#documentation": "

The reference point from which elevation is reported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a position.

" + } + }, + "com.amazonaws.privatenetworks#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifier of the affected resource.", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Type of the affected resource.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.privatenetworks#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.privatenetworks#SitePlan": { + "type": "structure", + "members": { + "resourceDefinitions": { + "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitions", + "traits": { + "smithy.api#documentation": "

The resource definitions of the plan.

" + } + }, + "options": { + "target": "com.amazonaws.privatenetworks#Options", + "traits": { + "smithy.api#documentation": "

The options of the plan.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a site plan.

" + } + }, + "com.amazonaws.privatenetworks#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[^\\x00-\\x1f\\x22]+$" + } + }, + "com.amazonaws.privatenetworks#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.privatenetworks#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.privatenetworks#TagKey" + }, + "value": { + "target": "com.amazonaws.privatenetworks#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.privatenetworks#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#AccessDeniedException" + }, + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ThrottlingException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Adds tags to the specified resource.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.privatenetworks#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.privatenetworks#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[^\\x00-\\x1f\\x22]*$" + } + }, + "com.amazonaws.privatenetworks#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

\n The request was denied due to request throttling.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.privatenetworks#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.privatenetworks#TrackingInformation": { + "type": "structure", + "members": { + "trackingNumber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The tracking number of the shipment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about tracking a shipment.

" + } + }, + "com.amazonaws.privatenetworks#TrackingInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#TrackingInformation" + } + }, + "com.amazonaws.privatenetworks#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#AccessDeniedException" + }, + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ThrottlingException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from the specified resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.privatenetworks#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.privatenetworks#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.privatenetworks#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.privatenetworks#UpdateNetworkSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified network site.

", + "smithy.api#http": { + "uri": "/v1/network-sites/site", + "method": "PUT", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#UpdateNetworkSitePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSitePlanRequest" + }, + "output": { + "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.privatenetworks#InternalServerException" + }, + { + "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.privatenetworks#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified network site plan.

", + "smithy.api#http": { + "uri": "/v1/network-sites/plan", + "method": "PUT", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.privatenetworks#UpdateNetworkSitePlanRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#required": {} + } + }, + "pendingPlan": { + "target": "com.amazonaws.privatenetworks#SitePlan", + "traits": { + "smithy.api#documentation": "

The pending plan.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + } + } + }, + "com.amazonaws.privatenetworks#UpdateNetworkSiteRequest": { + "type": "structure", + "members": { + "networkSiteArn": { + "target": "com.amazonaws.privatenetworks#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.privatenetworks#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" + } + }, + "description": { + "target": "com.amazonaws.privatenetworks#Description", + "traits": { + "smithy.api#documentation": "

The description.

" + } + } + } + }, + "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse": { + "type": "structure", + "members": { + "networkSite": { + "target": "com.amazonaws.privatenetworks#NetworkSite", + "traits": { + "smithy.api#documentation": "

Information about the network site.

" + } + }, + "tags": { + "target": "com.amazonaws.privatenetworks#TagMap", + "traits": { + "smithy.api#documentation": "

\n The network site tags.\n

" + } + } + } + }, + "com.amazonaws.privatenetworks#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.privatenetworks#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "Reason the request failed validation.", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.privatenetworks#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The list of fields that caused the error, if applicable." + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed validation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.privatenetworks#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The field name that failed validation.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The message about the validation failure.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a field that failed validation.

" + } + }, + "com.amazonaws.privatenetworks#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#ValidationExceptionField" + } + }, + "com.amazonaws.privatenetworks#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "CANNOT_ASSUME_ROLE", + "name": "CANNOT_ASSUME_ROLE" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + } + } +} \ No newline at end of file