CreateAppVersionAppComponent
Creates a new AppComponent in the AWS Resilience Hub application.
Note
This API updates the AWS Resilience Hub application draft version. To use this
AppComponent for running assessments, you must publish the AWS Resilience Hub
application using the PublishAppVersion API.
Request Syntax
POST /create-app-version-app-component HTTP/1.1
Content-type: application/json
{
"additionalInfo": {
"string" : [ "string" ]
},
"appArn": "string",
"clientToken": "string",
"id": "string",
"name": "string",
"type": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- additionalInfo
-
Currently, there is no supported additional information for AppComponents.
Type: String to array of strings map
Key Pattern:
^\S{1,128}$Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- appArn
-
Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn:
partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.Type: String
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
- clientToken
-
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[A-Za-z0-9_.-]{0,63}$Required: No
- id
-
Identifier of the AppComponent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- name
-
Name of the AppComponent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- type
-
Type of AppComponent. For more information about the types of AppComponent, see Grouping resources in an AppComponent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"appArn": "string",
"appComponent": {
"additionalInfo": {
"string" : [ "string" ]
},
"id": "string",
"name": "string",
"type": "string"
},
"appVersion": "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.
- appArn
-
Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn:
partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.Type: String
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}$ - appComponent
-
List of AppComponents that belong to this resource.
Type: AppComponent object
- appVersion
-
AWS Resilience Hub application version.
Type: String
Pattern:
^\S{1,50}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.
HTTP Status Code: 403
- ConflictException
-
This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
HTTP Status Code: 409
- InternalServerException
-
This exception occurs when there is an internal failure in the AWS Resilience Hub service.
HTTP Status Code: 500
- ResourceNotFoundException
-
This exception occurs when the specified resource could not be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
HTTP Status Code: 402
- ThrottlingException
-
This exception occurs when you have exceeded the limit on the number of requests per second.
HTTP Status Code: 429
- ValidationException
-
This exception occurs when a request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
