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

CreateServiceFunction

Creates a service function within a service.

Request Syntax


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

{
   "clientToken": "string",
   "criticality": "string",
   "description": "string",
   "name": "string",
   "serviceArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

Idempotency token.

Type: String

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

Pattern: [A-Za-z0-9_.-]{0,63}

Required: No

criticality

The criticality level of the service function.

Type: String

Valid Values: PRIMARY | SUPPLEMENTAL

Required: Yes

description

Resource description.

Type: String

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

Required: No

name

Entity label (not part of ARN — spaces allowed).

Type: String

Length Constraints: Minimum length of 2. Maximum length of 60.

Pattern: [A-Za-z0-9][A-Za-z0-9 _\-]{1,59}

Required: Yes

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

{
   "serviceFunction": { 
      "createdAt": number,
      "criticality": "string",
      "description": "string",
      "name": "string",
      "resourceCount": number,
      "serviceArn": "string",
      "serviceFunctionId": "string",
      "source": "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.

serviceFunction

The created service function.

Type: ServiceFunction 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