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

UpdateService

Updates an existing service.

Request Syntax


POST /v2/update-service HTTP/1.1
Content-type: application/json

{
   "associatedSystems": [ 
      { 
         "systemArn": "string",
         "systemName": "string",
         "userJourneyIds": [ "string" ]
      }
   ],
   "dependencyDiscovery": "string",
   "description": "string",
   "permissionModel": { 
      "crossAccountRoles": [ 
         { 
            "crossAccountRoleArn": "string",
            "externalId": "string"
         }
      ],
      "invokerRoleName": "string"
   },
   "policyArn": "string",
   "regions": [ "string" ],
   "reportConfiguration": { 
      "reportOutputs": [ 
         { ... }
      ]
   },
   "serviceArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

associatedSystems

The updated systems to associate with the service.

Type: Array of AssociatedSystem objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

dependencyDiscovery

Caller-settable values for dependency discovery. INITIALIZING is system-managed.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

description

Resource description for services and policies.

Type: String

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

Required: No

permissionModel

The updated permission model for the service.

Type: PermissionModel object

Required: No

policyArn

ARN identifier.

Type: String

Length Constraints: Minimum length of 31.

Pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

Required: No

regions

The updated AWS Regions where the service operates.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 6.

Pattern: [a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]

Required: No

reportConfiguration

Configuration for automatic report generation on a Service.

Type: ServiceReportConfiguration object

Required: No

serviceArn

ARN identifier.

Type: String

Length Constraints: Minimum length of 31.

Pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "service": { 
      "accountId": "string",
      "achievability": { 
         "availabilitySlo": "string",
         "multiAzRtoRpo": "string",
         "multiRegionRtoRpo": "string"
      },
      "assessmentStatus": "string",
      "associatedSystems": [ 
         { 
            "systemArn": "string",
            "systemName": "string",
            "userJourneyIds": [ "string" ]
         }
      ],
      "createdAt": number,
      "dependencyDiscovery": { 
         "status": "string",
         "updatedAt": number
      },
      "description": "string",
      "effectivePolicyValues": { 
         "availabilitySlo": { 
            "policyName": "string",
            "source": "string",
            "value": number
         },
         "dataRecoveryTimeBetweenBackups": { 
            "policyName": "string",
            "source": "string",
            "value": number
         },
         "multiAzDrApproach": { 
            "policyName": "string",
            "source": "string",
            "value": "string"
         },
         "multiAzRpo": { 
            "policyName": "string",
            "source": "string",
            "value": number
         },
         "multiAzRto": { 
            "policyName": "string",
            "source": "string",
            "value": number
         },
         "multiRegionDrApproach": { 
            "policyName": "string",
            "source": "string",
            "value": "string"
         },
         "multiRegionRpo": { 
            "policyName": "string",
            "source": "string",
            "value": number
         },
         "multiRegionRto": { 
            "policyName": "string",
            "source": "string",
            "value": number
         }
      },
      "estimatedAssessmentCost": { 
         "amount": number,
         "currency": "string"
      },
      "kmsKeyId": "string",
      "name": "string",
      "openFindingsCount": number,
      "organizationId": "string",
      "ouId": "string",
      "permissionModel": { 
         "crossAccountRoles": [ 
            { 
               "crossAccountRoleArn": "string",
               "externalId": "string"
            }
         ],
         "invokerRoleName": "string"
      },
      "policyArn": "string",
      "regions": [ "string" ],
      "reportConfiguration": { 
         "reportOutputs": [ 
            { ... }
         ]
      },
      "rerunAssessment": boolean,
      "resolvedFindingsCount": number,
      "resourceDiscovery": { 
         "errorCode": "string",
         "errorMessage": "string",
         "lastRunAt": number,
         "status": "string"
      },
      "serviceArn": "string",
      "tags": { 
         "string" : "string" 
      },
      "updatedAt": number
   }
}

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.

service

The updated service.

Type: Service object

Errors

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

AccessDeniedException

Access denied — caller lacks required permissions.

HTTP Status Code: 403

ConflictException

Conflict — resource already exists.

HTTP Status Code: 409

InternalServerException

Internal service error.

HTTP Status Code: 500

ResourceNotFoundException

Resource not found.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

Service quota exceeded.

HTTP Status Code: 402

ValidationException

Validation error — invalid input parameters.

fieldList: The list of fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400