Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ArchiveWave

Archive wave.

Request Syntax


POST /ArchiveWave HTTP/1.1
Content-type: application/json

{
   "accountID": "string",
   "waveID": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountID

Account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: .*[0-9]{12,}.*

Required: No

waveID

Wave ID.

Type: String

Length Constraints: Fixed length of 22.

Pattern: wave-[0-9a-zA-Z]{17}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationDateTime": "string",
   "description": "string",
   "isArchived": boolean,
   "lastModifiedDateTime": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   },
   "waveAggregatedStatus": { 
      "healthStatus": "string",
      "lastUpdateDateTime": "string",
      "progressStatus": "string",
      "replicationStartedDateTime": "string",
      "totalApplications": number
   },
   "waveID": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

Wave ARN.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

creationDateTime

Wave creation dateTime.

Type: String

Length Constraints: Minimum length of 19. Maximum length of 32.

Pattern: [1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z

description

Wave description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 600.

Pattern: [^\x00]*

isArchived

Wave archival status.

Type: Boolean

lastModifiedDateTime

Wave last modified dateTime.

Type: String

Length Constraints: Minimum length of 19. Maximum length of 32.

Pattern: [1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?Z

name

Wave name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\s\x00]( *[^\s\x00])*

tags

Wave tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 0. Maximum length of 256.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

waveAggregatedStatus

Wave aggregated status.

Type: WaveAggregatedStatus object

waveID

Wave ID.

Type: String

Length Constraints: Fixed length of 22.

Pattern: wave-[0-9a-zA-Z]{17}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The request could not be completed due to a conflict with the current state of the target resource.

errors: Conflict Exception specific errors.
resourceId: A conflict occurred when prompting for the Resource ID.
resourceType: A conflict occurred when prompting for resource type.

HTTP Status Code: 409

ResourceNotFoundException

Resource not found exception.

resourceId: Resource ID not found error.
resourceType: Resource type not found error.

HTTP Status Code: 404

ServiceQuotaExceededException

The request could not be completed because its exceeded the service quota.

quotaCode: Exceeded the service quota code.
quotaValue: Exceeded the service quota value.
resourceId: Exceeded the service quota resource ID.
resourceType: Exceeded the service quota resource type.
serviceCode: Exceeded the service quota service code.

HTTP Status Code: 402

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400