start_app_assessment(**kwargs)¶Creates a new application assessment for an application.
See also: AWS API Documentation
Request Syntax
response = client.start_app_assessment(
appArn='string',
appVersion='string',
assessmentName='string',
clientToken='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The 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.
[REQUIRED]
The version of the application.
[REQUIRED]
The name for the assessment.
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.
This field is autopopulated if not provided.
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
dict
Response Syntax
{
'assessment': {
'appArn': 'string',
'appVersion': 'string',
'assessmentArn': 'string',
'assessmentName': 'string',
'assessmentStatus': 'Pending'|'InProgress'|'Failed'|'Success',
'compliance': {
'string': {
'achievableRpoInSecs': 123,
'achievableRtoInSecs': 123,
'complianceStatus': 'PolicyBreached'|'PolicyMet',
'currentRpoInSecs': 123,
'currentRtoInSecs': 123,
'message': 'string',
'rpoDescription': 'string',
'rpoReferenceId': 'string',
'rtoDescription': 'string',
'rtoReferenceId': 'string'
}
},
'complianceStatus': 'PolicyBreached'|'PolicyMet',
'cost': {
'amount': 123.0,
'currency': 'string',
'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
},
'endTime': datetime(2015, 1, 1),
'invoker': 'User'|'System',
'message': 'string',
'policy': {
'creationTime': datetime(2015, 1, 1),
'dataLocationConstraint': 'AnyLocation'|'SameContinent'|'SameCountry',
'estimatedCostTier': 'L1'|'L2'|'L3'|'L4',
'policy': {
'string': {
'rpoInSecs': 123,
'rtoInSecs': 123
}
},
'policyArn': 'string',
'policyDescription': 'string',
'policyName': 'string',
'tags': {
'string': 'string'
},
'tier': 'MissionCritical'|'Critical'|'Important'|'CoreServices'|'NonCritical'
},
'resiliencyScore': {
'disruptionScore': {
'string': 123.0
},
'score': 123.0
},
'resourceErrorsDetails': {
'hasMoreErrors': True|False,
'resourceErrors': [
{
'logicalResourceId': 'string',
'physicalResourceId': 'string',
'reason': 'string'
},
]
},
'startTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
assessment (dict) --
The assessment created.
appArn (string) --
The 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.
appVersion (string) --
The version of the application.
assessmentArn (string) --
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn: partition :resiliencehub: region : account :app-assessment/ app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
assessmentName (string) --
The name of the assessment.
assessmentStatus (string) --
The current status of the assessment for the resiliency policy.
compliance (dict) --
The application compliance against the resiliency policy.
(string) --
(dict) --
Defines the compliance against the resiliency policy for a disruption.
achievableRpoInSecs (integer) --
The Recovery Point Objective (RPO) that is achievable, in seconds.
achievableRtoInSecs (integer) --
The Recovery Time Objective (RTO) that is achievable, in seconds
complianceStatus (string) --
The current status of compliance for the resiliency policy.
currentRpoInSecs (integer) --
The current RPO, in seconds.
currentRtoInSecs (integer) --
The current RTO, in seconds.
message (string) --
The disruption compliance message.
rpoDescription (string) --
The RPO description.
rpoReferenceId (string) --
The RPO reference identifier.
rtoDescription (string) --
The RTO description.
rtoReferenceId (string) --
The RTO reference identifier.
complianceStatus (string) --
The current status of the compliance for the resiliency policy.
cost (dict) --
The cost for the application.
amount (float) --
The cost amount.
currency (string) --
The cost currency, for example USD .
frequency (string) --
The cost frequency.
endTime (datetime) --
The end time for the action.
invoker (string) --
The entity that invoked the assessment.
message (string) --
Error or warning message from the assessment execution
policy (dict) --
The resiliency policy.
creationTime (datetime) --
The timestamp for when the resiliency policy was created.
dataLocationConstraint (string) --
Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
estimatedCostTier (string) --
Specifies the estimated cost tier of the resiliency policy.
policy (dict) --
The resiliency policy.
(string) --
(dict) --
Defines a failure policy.
rpoInSecs (integer) --
The Recovery Point Objective (RPO), in seconds.
rtoInSecs (integer) --
The Recovery Time Objective (RTO), in seconds.
policyArn (string) --
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.
policyDescription (string) --
The description for the policy.
policyName (string) --
The name of the policy
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
tier (string) --
The tier for this resiliency policy, ranging from the highest severity ( MissionCritical ) to lowest ( NonCritical ).
resiliencyScore (dict) --
The current resiliency score for the application.
disruptionScore (dict) --
The disruption score for a valid key.
score (float) --
The outage score for a valid key.
resourceErrorsDetails (dict) --
A resource error object containing a list of errors retrieving an application's resources.
hasMoreErrors (boolean) --
This indicates if there are more errors not listed in the resourceErrors list.
resourceErrors (list) --
A list of errors retrieving an application's resources.
(dict) --
Defines application resource errors.
logicalResourceId (string) --
This is the identifier of the resource.
physicalResourceId (string) --
This is the identifier of the physical resource.
reason (string) --
This is the error message.
startTime (datetime) --
The starting time for the action.
tags (dict) --
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.
Exceptions
ResilienceHub.Client.exceptions.InternalServerExceptionResilienceHub.Client.exceptions.ResourceNotFoundExceptionResilienceHub.Client.exceptions.ConflictExceptionResilienceHub.Client.exceptions.ServiceQuotaExceededExceptionResilienceHub.Client.exceptions.ThrottlingExceptionResilienceHub.Client.exceptions.ValidationExceptionResilienceHub.Client.exceptions.AccessDeniedException