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

AssociateSourceNetworkStack

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.

Request Syntax


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

{
   "cfnStackName": "string",
   "sourceNetworkID": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

cfnStackName

CloudFormation template to associate with a Source Network.

Type: String

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

Pattern: [a-zA-Z][-a-zA-Z0-9]*

Required: Yes

sourceNetworkID

The Source Network ID to associate with CloudFormation template.

Type: String

Length Constraints: Fixed length of 20.

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

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "job": { 
      "arn": "string",
      "creationDateTime": "string",
      "endDateTime": "string",
      "initiatedBy": "string",
      "jobID": "string",
      "participatingResources": [ 
         { 
            "launchStatus": "string",
            "participatingResourceID": { ... }
         }
      ],
      "participatingServers": [ 
         { 
            "launchActionsStatus": { 
               "runs": [ 
                  { 
                     "action": { 
                        "actionCode": "string",
                        "actionId": "string",
                        "actionVersion": "string",
                        "active": boolean,
                        "category": "string",
                        "description": "string",
                        "name": "string",
                        "optional": boolean,
                        "order": number,
                        "parameters": { 
                           "string" : { 
                              "type": "string",
                              "value": "string"
                           }
                        },
                        "type": "string"
                     },
                     "failureReason": "string",
                     "runId": "string",
                     "status": "string"
                  }
               ],
               "ssmAgentDiscoveryDatetime": "string"
            },
            "launchStatus": "string",
            "recoveryInstanceID": "string",
            "sourceServerID": "string"
         }
      ],
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string"
   }
}

Response Elements

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

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

job

The Source Network association Job.

Type: Job object

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.

resourceId: The ID of the resource.
resourceType: The type of the resource.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

retryAfterSeconds: The number of seconds after which the request should be safe to retry.

HTTP Status Code: 500

ResourceNotFoundException

The resource for this operation was not found.

resourceId: The ID of the resource.
resourceType: The type of the resource.

HTTP Status Code: 404

ServiceQuotaExceededException

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

quotaCode: Quota code.
resourceId: The ID of the resource.
resourceType: The type of the resource.
serviceCode: Service code.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

quotaCode: Quota code.
retryAfterSeconds: The number of seconds after which the request should be safe to retry.
serviceCode: Service code.

HTTP Status Code: 429

UninitializedAccountException

The account performing the request has not been initialized.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

fieldList: A list of fields that failed validation.
reason: Validation exception reason.

HTTP Status Code: 400