AcceptResourceGroupingRecommendations

$result = $client->acceptResourceGroupingRecommendations([/* ... */]);
$promise = $client->acceptResourceGroupingRecommendationsAsync([/* ... */]);

Accepts the resource grouping recommendations suggested by Resilience Hub for your application.

Parameter Syntax

$result = $client->acceptResourceGroupingRecommendations([
    'appArn' => '<string>', // REQUIRED
    'entries' => [ // REQUIRED
        [
            'groupingRecommendationId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'failedEntries' => [
        [
            'errorMessage' => '<string>',
            'groupingRecommendationId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

AddDraftAppVersionResourceMappings

$result = $client->addDraftAppVersionResourceMappings([/* ... */]);
$promise = $client->addDraftAppVersionResourceMappingsAsync([/* ... */]);

Adds the source of resource-maps to the draft version of an application. During assessment, Resilience Hub will use these resource-maps to resolve the latest physical ID for each resource in the application template. For more information about different types of resources supported by Resilience Hub and how to add them in your application, see Step 2: How is your application managed? in the Resilience Hub User Guide.

Parameter Syntax

$result = $client->addDraftAppVersionResourceMappings([
    'appArn' => '<string>', // REQUIRED
    'resourceMappings' => [ // REQUIRED
        [
            'appRegistryAppName' => '<string>',
            'eksSourceName' => '<string>',
            'logicalStackName' => '<string>',
            'mappingType' => 'CfnStack|Resource|AppRegistryApp|ResourceGroup|Terraform|EKS', // REQUIRED
            'physicalResourceId' => [ // REQUIRED
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>', // REQUIRED
                'type' => 'Arn|Native', // REQUIRED
            ],
            'resourceGroupName' => '<string>',
            'resourceName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'resourceMappings' => [
        [
            'appRegistryAppName' => '<string>',
            'eksSourceName' => '<string>',
            'logicalStackName' => '<string>',
            'mappingType' => 'CfnStack|Resource|AppRegistryApp|ResourceGroup|Terraform|EKS',
            'physicalResourceId' => [
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>',
                'type' => 'Arn|Native',
            ],
            'resourceGroupName' => '<string>',
            'resourceName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

BatchUpdateRecommendationStatus

$result = $client->batchUpdateRecommendationStatus([/* ... */]);
$promise = $client->batchUpdateRecommendationStatusAsync([/* ... */]);

Enables you to include or exclude one or more operational recommendations.

Parameter Syntax

$result = $client->batchUpdateRecommendationStatus([
    'appArn' => '<string>', // REQUIRED
    'requestEntries' => [ // REQUIRED
        [
            'appComponentId' => '<string>',
            'entryId' => '<string>', // REQUIRED
            'excludeReason' => 'AlreadyImplemented|NotRelevant|ComplexityOfImplementation',
            'excluded' => true || false, // REQUIRED
            'item' => [
                'resourceId' => '<string>',
                'targetAccountId' => '<string>',
                'targetRegion' => '<string>',
            ],
            'referenceId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'failedEntries' => [
        [
            'entryId' => '<string>',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
    'successfulEntries' => [
        [
            'appComponentId' => '<string>',
            'entryId' => '<string>',
            'excludeReason' => 'AlreadyImplemented|NotRelevant|ComplexityOfImplementation',
            'excluded' => true || false,
            'item' => [
                'resourceId' => '<string>',
                'targetAccountId' => '<string>',
                'targetRegion' => '<string>',
            ],
            'referenceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

CreateApp

$result = $client->createApp([/* ... */]);
$promise = $client->createAppAsync([/* ... */]);

Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas.

After you create an Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).

Parameter Syntax

$result = $client->createApp([
    'assessmentSchedule' => 'Disabled|Daily',
    'awsApplicationArn' => '<string>',
    'clientToken' => '<string>',
    'description' => '<string>',
    'eventSubscriptions' => [
        [
            'eventType' => 'ScheduledAssessmentFailure|DriftDetected', // REQUIRED
            'name' => '<string>', // REQUIRED
            'snsTopicArn' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'permissionModel' => [
        'crossAccountRoleArns' => ['<string>', ...],
        'invokerRoleName' => '<string>',
        'type' => 'LegacyIAMUser|RoleBased', // REQUIRED
    ],
    'policyArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'assessmentSchedule' => 'Disabled|Daily',
        'awsApplicationArn' => '<string>',
        'complianceStatus' => 'PolicyBreached|PolicyMet|NotAssessed|ChangesDetected|NotApplicable|MissingPolicy',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'driftStatus' => 'NotChecked|NotDetected|Detected',
        'eventSubscriptions' => [
            [
                'eventType' => 'ScheduledAssessmentFailure|DriftDetected',
                'name' => '<string>',
                'snsTopicArn' => '<string>',
            ],
            // ...
        ],
        'lastAppComplianceEvaluationTime' => <DateTime>,
        'lastDriftEvaluationTime' => <DateTime>,
        'lastResiliencyScoreEvaluationTime' => <DateTime>,
        'name' => '<string>',
        'permissionModel' => [
            'crossAccountRoleArns' => ['<string>', ...],
            'invokerRoleName' => '<string>',
            'type' => 'LegacyIAMUser|RoleBased',
        ],
        'policyArn' => '<string>',
        'resiliencyScore' => <float>,
        'rpoInSecs' => <integer>,
        'rtoInSecs' => <integer>,
        'status' => 'Active|Deleting',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

CreateAppVersionAppComponent

$result = $client->createAppVersionAppComponent([/* ... */]);
$promise = $client->createAppVersionAppComponentAsync([/* ... */]);

Creates a new Application Component in the Resilience Hub application.

Parameter Syntax

$result = $client->createAppVersionAppComponent([
    'additionalInfo' => [
        '<String128WithoutWhitespace>' => ['<string>', ...],
        // ...
    ],
    'appArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'id' => '<string>',
    'name' => '<string>', // REQUIRED
    'type' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appComponent' => [
        'additionalInfo' => [
            '<String128WithoutWhitespace>' => ['<string>', ...],
            // ...
        ],
        'id' => '<string>',
        'name' => '<string>',
        'type' => '<string>',
    ],
    'appVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

CreateAppVersionResource

$result = $client->createAppVersionResource([/* ... */]);
$promise = $client->createAppVersionResourceAsync([/* ... */]);

Adds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component.

Parameter Syntax

$result = $client->createAppVersionResource([
    'additionalInfo' => [
        '<String128WithoutWhitespace>' => ['<string>', ...],
        // ...
    ],
    'appArn' => '<string>', // REQUIRED
    'appComponents' => ['<string>', ...], // REQUIRED
    'awsAccountId' => '<string>',
    'awsRegion' => '<string>',
    'clientToken' => '<string>',
    'logicalResourceId' => [ // REQUIRED
        'eksSourceName' => '<string>',
        'identifier' => '<string>', // REQUIRED
        'logicalStackName' => '<string>',
        'resourceGroupName' => '<string>',
        'terraformSourceName' => '<string>',
    ],
    'physicalResourceId' => '<string>', // REQUIRED
    'resourceName' => '<string>',
    'resourceType' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'physicalResource' => [
        'additionalInfo' => [
            '<String128WithoutWhitespace>' => ['<string>', ...],
            // ...
        ],
        'appComponents' => [
            [
                'additionalInfo' => [
                    '<String128WithoutWhitespace>' => ['<string>', ...],
                    // ...
                ],
                'id' => '<string>',
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'excluded' => true || false,
        'logicalResourceId' => [
            'eksSourceName' => '<string>',
            'identifier' => '<string>',
            'logicalStackName' => '<string>',
            'resourceGroupName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        'parentResourceName' => '<string>',
        'physicalResourceId' => [
            'awsAccountId' => '<string>',
            'awsRegion' => '<string>',
            'identifier' => '<string>',
            'type' => 'Arn|Native',
        ],
        'resourceName' => '<string>',
        'resourceType' => '<string>',
        'sourceType' => 'AppTemplate|Discovered',
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

CreateRecommendationTemplate

$result = $client->createRecommendationTemplate([/* ... */]);
$promise = $client->createRecommendationTemplateAsync([/* ... */]);

Creates a new recommendation template for the Resilience Hub application.

Parameter Syntax

$result = $client->createRecommendationTemplate([
    'assessmentArn' => '<string>', // REQUIRED
    'bucketName' => '<string>',
    'clientToken' => '<string>',
    'format' => 'CfnYaml|CfnJson',
    'name' => '<string>', // REQUIRED
    'recommendationIds' => ['<string>', ...],
    'recommendationTypes' => ['<string>', ...],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'recommendationTemplate' => [
        'appArn' => '<string>',
        'assessmentArn' => '<string>',
        'endTime' => <DateTime>,
        'format' => 'CfnYaml|CfnJson',
        'message' => '<string>',
        'name' => '<string>',
        'needsReplacements' => true || false,
        'recommendationIds' => ['<string>', ...],
        'recommendationTemplateArn' => '<string>',
        'recommendationTypes' => ['<string>', ...],
        'startTime' => <DateTime>,
        'status' => 'Pending|InProgress|Failed|Success',
        'tags' => ['<string>', ...],
        'templatesLocation' => [
            'bucket' => '<string>',
            'prefix' => '<string>',
        ],
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

CreateResiliencyPolicy

$result = $client->createResiliencyPolicy([/* ... */]);
$promise = $client->createResiliencyPolicyAsync([/* ... */]);

Creates a resiliency policy for an application.

Parameter Syntax

$result = $client->createResiliencyPolicy([
    'clientToken' => '<string>',
    'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
    'policy' => [ // REQUIRED
        '<DisruptionType>' => [
            'rpoInSecs' => <integer>, // REQUIRED
            'rtoInSecs' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'policyDescription' => '<string>',
    'policyName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical|NotApplicable', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => [
        'creationTime' => <DateTime>,
        'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
        'estimatedCostTier' => 'L1|L2|L3|L4',
        'policy' => [
            '<DisruptionType>' => [
                'rpoInSecs' => <integer>,
                'rtoInSecs' => <integer>,
            ],
            // ...
        ],
        'policyArn' => '<string>',
        'policyDescription' => '<string>',
        'policyName' => '<string>',
        'tags' => ['<string>', ...],
        'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical|NotApplicable',
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

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.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DeleteApp

$result = $client->deleteApp([/* ... */]);
$promise = $client->deleteAppAsync([/* ... */]);

Deletes an Resilience Hub application. This is a destructive action that can't be undone.

Parameter Syntax

$result = $client->deleteApp([
    'appArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'forceDelete' => true || false,
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

DeleteAppAssessment

$result = $client->deleteAppAssessment([/* ... */]);
$promise = $client->deleteAppAssessmentAsync([/* ... */]);

Deletes an Resilience Hub application assessment. This is a destructive action that can't be undone.

Parameter Syntax

$result = $client->deleteAppAssessment([
    'assessmentArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assessmentArn' => '<string>',
    'assessmentStatus' => 'Pending|InProgress|Failed|Success',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DeleteAppInputSource

$result = $client->deleteAppInputSource([/* ... */]);
$promise = $client->deleteAppInputSourceAsync([/* ... */]);

Deletes the input source and all of its imported resources from the Resilience Hub application.

Parameter Syntax

$result = $client->deleteAppInputSource([
    'appArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'eksSourceClusterNamespace' => [
        'eksClusterArn' => '<string>', // REQUIRED
        'namespace' => '<string>', // REQUIRED
    ],
    'sourceArn' => '<string>',
    'terraformSource' => [
        's3StateFileUrl' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appInputSource' => [
        'eksSourceClusterNamespace' => [
            'eksClusterArn' => '<string>',
            'namespace' => '<string>',
        ],
        'importType' => 'CfnStack|Resource|AppRegistryApp|ResourceGroup|Terraform|EKS',
        'resourceCount' => <integer>,
        'sourceArn' => '<string>',
        'sourceName' => '<string>',
        'terraformSource' => [
            's3StateFileUrl' => '<string>',
        ],
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DeleteAppVersionAppComponent

$result = $client->deleteAppVersionAppComponent([/* ... */]);
$promise = $client->deleteAppVersionAppComponentAsync([/* ... */]);

Deletes an Application Component from the Resilience Hub application.

Parameter Syntax

$result = $client->deleteAppVersionAppComponent([
    'appArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appComponent' => [
        'additionalInfo' => [
            '<String128WithoutWhitespace>' => ['<string>', ...],
            // ...
        ],
        'id' => '<string>',
        'name' => '<string>',
        'type' => '<string>',
    ],
    'appVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DeleteAppVersionResource

$result = $client->deleteAppVersionResource([/* ... */]);
$promise = $client->deleteAppVersionResourceAsync([/* ... */]);

Deletes a resource from the Resilience Hub application.

Parameter Syntax

$result = $client->deleteAppVersionResource([
    'appArn' => '<string>', // REQUIRED
    'awsAccountId' => '<string>',
    'awsRegion' => '<string>',
    'clientToken' => '<string>',
    'logicalResourceId' => [
        'eksSourceName' => '<string>',
        'identifier' => '<string>', // REQUIRED
        'logicalStackName' => '<string>',
        'resourceGroupName' => '<string>',
        'terraformSourceName' => '<string>',
    ],
    'physicalResourceId' => '<string>',
    'resourceName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'physicalResource' => [
        'additionalInfo' => [
            '<String128WithoutWhitespace>' => ['<string>', ...],
            // ...
        ],
        'appComponents' => [
            [
                'additionalInfo' => [
                    '<String128WithoutWhitespace>' => ['<string>', ...],
                    // ...
                ],
                'id' => '<string>',
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'excluded' => true || false,
        'logicalResourceId' => [
            'eksSourceName' => '<string>',
            'identifier' => '<string>',
            'logicalStackName' => '<string>',
            'resourceGroupName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        'parentResourceName' => '<string>',
        'physicalResourceId' => [
            'awsAccountId' => '<string>',
            'awsRegion' => '<string>',
            'identifier' => '<string>',
            'type' => 'Arn|Native',
        ],
        'resourceName' => '<string>',
        'resourceType' => '<string>',
        'sourceType' => 'AppTemplate|Discovered',
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DeleteRecommendationTemplate

$result = $client->deleteRecommendationTemplate([/* ... */]);
$promise = $client->deleteRecommendationTemplateAsync([/* ... */]);

Deletes a recommendation template. This is a destructive action that can't be undone.

Parameter Syntax

$result = $client->deleteRecommendationTemplate([
    'clientToken' => '<string>',
    'recommendationTemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'recommendationTemplateArn' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DeleteResiliencyPolicy

$result = $client->deleteResiliencyPolicy([/* ... */]);
$promise = $client->deleteResiliencyPolicyAsync([/* ... */]);

Deletes a resiliency policy. This is a destructive action that can't be undone.

Parameter Syntax

$result = $client->deleteResiliencyPolicy([
    'clientToken' => '<string>',
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policyArn' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeApp

$result = $client->describeApp([/* ... */]);
$promise = $client->describeAppAsync([/* ... */]);

Describes an Resilience Hub application.

Parameter Syntax

$result = $client->describeApp([
    'appArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'app' => [
        'appArn' => '<string>',
        'assessmentSchedule' => 'Disabled|Daily',
        'awsApplicationArn' => '<string>',
        'complianceStatus' => 'PolicyBreached|PolicyMet|NotAssessed|ChangesDetected|NotApplicable|MissingPolicy',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'driftStatus' => 'NotChecked|NotDetected|Detected',
        'eventSubscriptions' => [
            [
                'eventType' => 'ScheduledAssessmentFailure|DriftDetected',
                'name' => '<string>',
                'snsTopicArn' => '<string>',
            ],
            // ...
        ],
        'lastAppComplianceEvaluationTime' => <DateTime>,
        'lastDriftEvaluationTime' => <DateTime>,
        'lastResiliencyScoreEvaluationTime' => <DateTime>,
        'name' => '<string>',
        'permissionModel' => [
            'crossAccountRoleArns' => ['<string>', ...],
            'invokerRoleName' => '<string>',
            'type' => 'LegacyIAMUser|RoleBased',
        ],
        'policyArn' => '<string>',
        'resiliencyScore' => <float>,
        'rpoInSecs' => <integer>,
        'rtoInSecs' => <integer>,
        'status' => 'Active|Deleting',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeAppAssessment

$result = $client->describeAppAssessment([/* ... */]);
$promise = $client->describeAppAssessmentAsync([/* ... */]);

Describes an assessment for an Resilience Hub application.

Parameter Syntax

$result = $client->describeAppAssessment([
    'assessmentArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assessment' => [
        'appArn' => '<string>',
        'appVersion' => '<string>',
        'assessmentArn' => '<string>',
        'assessmentName' => '<string>',
        'assessmentStatus' => 'Pending|InProgress|Failed|Success',
        'compliance' => [
            '<DisruptionType>' => [
                'achievableRpoInSecs' => <integer>,
                'achievableRtoInSecs' => <integer>,
                'complianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
                'currentRpoInSecs' => <integer>,
                'currentRtoInSecs' => <integer>,
                'message' => '<string>',
                'rpoDescription' => '<string>',
                'rpoReferenceId' => '<string>',
                'rtoDescription' => '<string>',
                'rtoReferenceId' => '<string>',
            ],
            // ...
        ],
        'complianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
        'cost' => [
            'amount' => <float>,
            'currency' => '<string>',
            'frequency' => 'Hourly|Daily|Monthly|Yearly',
        ],
        'driftStatus' => 'NotChecked|NotDetected|Detected',
        'endTime' => <DateTime>,
        'invoker' => 'User|System',
        'message' => '<string>',
        'policy' => [
            'creationTime' => <DateTime>,
            'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
            'estimatedCostTier' => 'L1|L2|L3|L4',
            'policy' => [
                '<DisruptionType>' => [
                    'rpoInSecs' => <integer>,
                    'rtoInSecs' => <integer>,
                ],
                // ...
            ],
            'policyArn' => '<string>',
            'policyDescription' => '<string>',
            'policyName' => '<string>',
            'tags' => ['<string>', ...],
            'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical|NotApplicable',
        ],
        'resiliencyScore' => [
            'componentScore' => [
                '<ResiliencyScoreType>' => [
                    'excludedCount' => <integer>,
                    'outstandingCount' => <integer>,
                    'possibleScore' => <float>,
                    'score' => <float>,
                ],
                // ...
            ],
            'disruptionScore' => [<float>, ...],
            'score' => <float>,
        ],
        'resourceErrorsDetails' => [
            'hasMoreErrors' => true || false,
            'resourceErrors' => [
                [
                    'logicalResourceId' => '<string>',
                    'physicalResourceId' => '<string>',
                    'reason' => '<string>',
                ],
                // ...
            ],
        ],
        'startTime' => <DateTime>,
        'summary' => [
            'riskRecommendations' => [
                [
                    'appComponents' => ['<string>', ...],
                    'recommendation' => '<string>',
                    'risk' => '<string>',
                ],
                // ...
            ],
            'summary' => '<string>',
        ],
        'tags' => ['<string>', ...],
        'versionName' => '<string>',
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeAppVersion

$result = $client->describeAppVersion([/* ... */]);
$promise = $client->describeAppVersionAsync([/* ... */]);

Describes the Resilience Hub application version.

Parameter Syntax

$result = $client->describeAppVersion([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'additionalInfo' => [
        '<String128WithoutWhitespace>' => ['<string>', ...],
        // ...
    ],
    'appArn' => '<string>',
    'appVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeAppVersionAppComponent

$result = $client->describeAppVersionAppComponent([/* ... */]);
$promise = $client->describeAppVersionAppComponentAsync([/* ... */]);

Describes an Application Component in the Resilience Hub application.

Parameter Syntax

$result = $client->describeAppVersionAppComponent([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appComponent' => [
        'additionalInfo' => [
            '<String128WithoutWhitespace>' => ['<string>', ...],
            // ...
        ],
        'id' => '<string>',
        'name' => '<string>',
        'type' => '<string>',
    ],
    'appVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeAppVersionResource

$result = $client->describeAppVersionResource([/* ... */]);
$promise = $client->describeAppVersionResourceAsync([/* ... */]);

Describes a resource of the Resilience Hub application.

Parameter Syntax

$result = $client->describeAppVersionResource([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'awsAccountId' => '<string>',
    'awsRegion' => '<string>',
    'logicalResourceId' => [
        'eksSourceName' => '<string>',
        'identifier' => '<string>', // REQUIRED
        'logicalStackName' => '<string>',
        'resourceGroupName' => '<string>',
        'terraformSourceName' => '<string>',
    ],
    'physicalResourceId' => '<string>',
    'resourceName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'physicalResource' => [
        'additionalInfo' => [
            '<String128WithoutWhitespace>' => ['<string>', ...],
            // ...
        ],
        'appComponents' => [
            [
                'additionalInfo' => [
                    '<String128WithoutWhitespace>' => ['<string>', ...],
                    // ...
                ],
                'id' => '<string>',
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'excluded' => true || false,
        'logicalResourceId' => [
            'eksSourceName' => '<string>',
            'identifier' => '<string>',
            'logicalStackName' => '<string>',
            'resourceGroupName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        'parentResourceName' => '<string>',
        'physicalResourceId' => [
            'awsAccountId' => '<string>',
            'awsRegion' => '<string>',
            'identifier' => '<string>',
            'type' => 'Arn|Native',
        ],
        'resourceName' => '<string>',
        'resourceType' => '<string>',
        'sourceType' => 'AppTemplate|Discovered',
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeAppVersionResourcesResolutionStatus

$result = $client->describeAppVersionResourcesResolutionStatus([/* ... */]);
$promise = $client->describeAppVersionResourcesResolutionStatusAsync([/* ... */]);

Returns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.

Parameter Syntax

$result = $client->describeAppVersionResourcesResolutionStatus([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'resolutionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'errorMessage' => '<string>',
    'resolutionId' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeAppVersionTemplate

$result = $client->describeAppVersionTemplate([/* ... */]);
$promise = $client->describeAppVersionTemplateAsync([/* ... */]);

Describes details about an Resilience Hub application.

Parameter Syntax

$result = $client->describeAppVersionTemplate([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appTemplateBody' => '<string>',
    'appVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeDraftAppVersionResourcesImportStatus

$result = $client->describeDraftAppVersionResourcesImportStatus([/* ... */]);
$promise = $client->describeDraftAppVersionResourcesImportStatusAsync([/* ... */]);

Describes the status of importing resources to an application version.

Parameter Syntax

$result = $client->describeDraftAppVersionResourcesImportStatus([
    'appArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'errorDetails' => [
        [
            'errorMessage' => '<string>',
        ],
        // ...
    ],
    'errorMessage' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
    'statusChangeTime' => <DateTime>,
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeMetricsExport

$result = $client->describeMetricsExport([/* ... */]);
$promise = $client->describeMetricsExportAsync([/* ... */]);

Describes the metrics of the application configuration being exported.

Parameter Syntax

$result = $client->describeMetricsExport([
    'metricsExportId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errorMessage' => '<string>',
    'exportLocation' => [
        'bucket' => '<string>',
        'prefix' => '<string>',
    ],
    'metricsExportId' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeResiliencyPolicy

$result = $client->describeResiliencyPolicy([/* ... */]);
$promise = $client->describeResiliencyPolicyAsync([/* ... */]);

Describes a specified resiliency policy for an Resilience Hub application. The returned policy object includes creation time, data location constraints, the Amazon Resource Name (ARN) for the policy, tags, tier, and more.

Parameter Syntax

$result = $client->describeResiliencyPolicy([
    'policyArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policy' => [
        'creationTime' => <DateTime>,
        'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
        'estimatedCostTier' => 'L1|L2|L3|L4',
        'policy' => [
            '<DisruptionType>' => [
                'rpoInSecs' => <integer>,
                'rtoInSecs' => <integer>,
            ],
            // ...
        ],
        'policyArn' => '<string>',
        'policyDescription' => '<string>',
        'policyName' => '<string>',
        'tags' => ['<string>', ...],
        'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical|NotApplicable',
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

DescribeResourceGroupingRecommendationTask

$result = $client->describeResourceGroupingRecommendationTask([/* ... */]);
$promise = $client->describeResourceGroupingRecommendationTaskAsync([/* ... */]);

Describes the resource grouping recommendation tasks run by Resilience Hub for your application.

Parameter Syntax

$result = $client->describeResourceGroupingRecommendationTask([
    'appArn' => '<string>', // REQUIRED
    'groupingId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'errorMessage' => '<string>',
    'groupingId' => '<string>',
    'status' => 'Pending|InProgress|Failed|Success',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ImportResourcesToDraftAppVersion

$result = $client->importResourcesToDraftAppVersion([/* ... */]);
$promise = $client->importResourcesToDraftAppVersionAsync([/* ... */]);

Imports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.

Parameter Syntax

$result = $client->importResourcesToDraftAppVersion([
    'appArn' => '<string>', // REQUIRED
    'eksSources' => [
        [
            'eksClusterArn' => '<string>', // REQUIRED
            'namespaces' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'importStrategy' => 'AddOnly|ReplaceAll',
    'sourceArns' => ['<string>', ...],
    'terraformSources' => [
        [
            's3StateFileUrl' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'eksSources' => [
        [
            'eksClusterArn' => '<string>',
            'namespaces' => ['<string>', ...],
        ],
        // ...
    ],
    'sourceArns' => ['<string>', ...],
    'status' => 'Pending|InProgress|Failed|Success',
    'terraformSources' => [
        [
            's3StateFileUrl' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAlarmRecommendations

$result = $client->listAlarmRecommendations([/* ... */]);
$promise = $client->listAlarmRecommendationsAsync([/* ... */]);

Lists the alarm recommendations for an Resilience Hub application.

Parameter Syntax

$result = $client->listAlarmRecommendations([
    'assessmentArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'alarmRecommendations' => [
        [
            'appComponentName' => '<string>',
            'appComponentNames' => ['<string>', ...],
            'description' => '<string>',
            'items' => [
                [
                    'alreadyImplemented' => true || false,
                    'discoveredAlarm' => [
                        'alarmArn' => '<string>',
                        'source' => '<string>',
                    ],
                    'excludeReason' => 'AlreadyImplemented|NotRelevant|ComplexityOfImplementation',
                    'excluded' => true || false,
                    'latestDiscoveredExperiment' => [
                        'experimentArn' => '<string>',
                        'experimentTemplateId' => '<string>',
                    ],
                    'resourceId' => '<string>',
                    'targetAccountId' => '<string>',
                    'targetRegion' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'prerequisite' => '<string>',
            'recommendationId' => '<string>',
            'recommendationStatus' => 'Implemented|Inactive|NotImplemented|Excluded',
            'referenceId' => '<string>',
            'type' => 'Metric|Composite|Canary|Logs|Event',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppAssessmentComplianceDrifts

$result = $client->listAppAssessmentComplianceDrifts([/* ... */]);
$promise = $client->listAppAssessmentComplianceDriftsAsync([/* ... */]);

List of compliance drifts that were detected while running an assessment.

Parameter Syntax

$result = $client->listAppAssessmentComplianceDrifts([
    'assessmentArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'complianceDrifts' => [
        [
            'actualReferenceId' => '<string>',
            'actualValue' => [
                '<DisruptionType>' => [
                    'achievableRpoInSecs' => <integer>,
                    'achievableRtoInSecs' => <integer>,
                    'complianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
                    'currentRpoInSecs' => <integer>,
                    'currentRtoInSecs' => <integer>,
                    'message' => '<string>',
                    'rpoDescription' => '<string>',
                    'rpoReferenceId' => '<string>',
                    'rtoDescription' => '<string>',
                    'rtoReferenceId' => '<string>',
                ],
                // ...
            ],
            'appId' => '<string>',
            'appVersion' => '<string>',
            'diffType' => 'NotEqual|Added|Removed',
            'driftType' => 'ApplicationCompliance|AppComponentResiliencyComplianceStatus',
            'entityId' => '<string>',
            'entityType' => '<string>',
            'expectedReferenceId' => '<string>',
            'expectedValue' => [
                '<DisruptionType>' => [
                    'achievableRpoInSecs' => <integer>,
                    'achievableRtoInSecs' => <integer>,
                    'complianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
                    'currentRpoInSecs' => <integer>,
                    'currentRtoInSecs' => <integer>,
                    'message' => '<string>',
                    'rpoDescription' => '<string>',
                    'rpoReferenceId' => '<string>',
                    'rtoDescription' => '<string>',
                    'rtoReferenceId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppAssessmentResourceDrifts

$result = $client->listAppAssessmentResourceDrifts([/* ... */]);
$promise = $client->listAppAssessmentResourceDriftsAsync([/* ... */]);

List of resource drifts that were detected while running an assessment.

Parameter Syntax

$result = $client->listAppAssessmentResourceDrifts([
    'assessmentArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resourceDrifts' => [
        [
            'appArn' => '<string>',
            'appVersion' => '<string>',
            'diffType' => 'NotEqual|Added|Removed',
            'referenceId' => '<string>',
            'resourceIdentifier' => [
                'logicalResourceId' => [
                    'eksSourceName' => '<string>',
                    'identifier' => '<string>',
                    'logicalStackName' => '<string>',
                    'resourceGroupName' => '<string>',
                    'terraformSourceName' => '<string>',
                ],
                'resourceType' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppAssessments

$result = $client->listAppAssessments([/* ... */]);
$promise = $client->listAppAssessmentsAsync([/* ... */]);

Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.

Parameter Syntax

$result = $client->listAppAssessments([
    'appArn' => '<string>',
    'assessmentName' => '<string>',
    'assessmentStatus' => ['<string>', ...],
    'complianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
    'invoker' => 'User|System',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'reverseOrder' => true || false,
]);

Parameter Details

Result Syntax

[
    'assessmentSummaries' => [
        [
            'appArn' => '<string>',
            'appVersion' => '<string>',
            'assessmentArn' => '<string>',
            'assessmentName' => '<string>',
            'assessmentStatus' => 'Pending|InProgress|Failed|Success',
            'complianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
            'cost' => [
                'amount' => <float>,
                'currency' => '<string>',
                'frequency' => 'Hourly|Daily|Monthly|Yearly',
            ],
            'driftStatus' => 'NotChecked|NotDetected|Detected',
            'endTime' => <DateTime>,
            'invoker' => 'User|System',
            'message' => '<string>',
            'resiliencyScore' => <float>,
            'startTime' => <DateTime>,
            'versionName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppComponentCompliances

$result = $client->listAppComponentCompliances([/* ... */]);
$promise = $client->listAppComponentCompliancesAsync([/* ... */]);

Lists the compliances for an Resilience Hub Application Component.

Parameter Syntax

$result = $client->listAppComponentCompliances([
    'assessmentArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'componentCompliances' => [
        [
            'appComponentName' => '<string>',
            'compliance' => [
                '<DisruptionType>' => [
                    'achievableRpoInSecs' => <integer>,
                    'achievableRtoInSecs' => <integer>,
                    'complianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
                    'currentRpoInSecs' => <integer>,
                    'currentRtoInSecs' => <integer>,
                    'message' => '<string>',
                    'rpoDescription' => '<string>',
                    'rpoReferenceId' => '<string>',
                    'rtoDescription' => '<string>',
                    'rtoReferenceId' => '<string>',
                ],
                // ...
            ],
            'cost' => [
                'amount' => <float>,
                'currency' => '<string>',
                'frequency' => 'Hourly|Daily|Monthly|Yearly',
            ],
            'message' => '<string>',
            'resiliencyScore' => [
                'componentScore' => [
                    '<ResiliencyScoreType>' => [
                        'excludedCount' => <integer>,
                        'outstandingCount' => <integer>,
                        'possibleScore' => <float>,
                        'score' => <float>,
                    ],
                    // ...
                ],
                'disruptionScore' => [<float>, ...],
                'score' => <float>,
            ],
            'status' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppComponentRecommendations

$result = $client->listAppComponentRecommendations([/* ... */]);
$promise = $client->listAppComponentRecommendationsAsync([/* ... */]);

Lists the recommendations for an Resilience Hub Application Component.

Parameter Syntax

$result = $client->listAppComponentRecommendations([
    'assessmentArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'componentRecommendations' => [
        [
            'appComponentName' => '<string>',
            'configRecommendations' => [
                [
                    'appComponentName' => '<string>',
                    'compliance' => [
                        '<DisruptionType>' => [
                            'achievableRpoInSecs' => <integer>,
                            'achievableRtoInSecs' => <integer>,
                            'complianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
                            'currentRpoInSecs' => <integer>,
                            'currentRtoInSecs' => <integer>,
                            'message' => '<string>',
                            'rpoDescription' => '<string>',
                            'rpoReferenceId' => '<string>',
                            'rtoDescription' => '<string>',
                            'rtoReferenceId' => '<string>',
                        ],
                        // ...
                    ],
                    'cost' => [
                        'amount' => <float>,
                        'currency' => '<string>',
                        'frequency' => 'Hourly|Daily|Monthly|Yearly',
                    ],
                    'description' => '<string>',
                    'haArchitecture' => 'MultiSite|WarmStandby|PilotLight|BackupAndRestore|NoRecoveryPlan',
                    'name' => '<string>',
                    'optimizationType' => 'LeastCost|LeastChange|BestAZRecovery|LeastErrors|BestAttainable|BestRegionRecovery',
                    'recommendationCompliance' => [
                        '<DisruptionType>' => [
                            'expectedComplianceStatus' => 'PolicyBreached|PolicyMet|NotApplicable|MissingPolicy',
                            'expectedRpoDescription' => '<string>',
                            'expectedRpoInSecs' => <integer>,
                            'expectedRtoDescription' => '<string>',
                            'expectedRtoInSecs' => <integer>,
                        ],
                        // ...
                    ],
                    'referenceId' => '<string>',
                    'suggestedChanges' => ['<string>', ...],
                ],
                // ...
            ],
            'recommendationStatus' => 'BreachedUnattainable|BreachedCanMeet|MetCanImprove|MissingPolicy',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppInputSources

$result = $client->listAppInputSources([/* ... */]);
$promise = $client->listAppInputSourcesAsync([/* ... */]);

Lists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.

Parameter Syntax

$result = $client->listAppInputSources([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appInputSources' => [
        [
            'eksSourceClusterNamespace' => [
                'eksClusterArn' => '<string>',
                'namespace' => '<string>',
            ],
            'importType' => 'CfnStack|Resource|AppRegistryApp|ResourceGroup|Terraform|EKS',
            'resourceCount' => <integer>,
            'sourceArn' => '<string>',
            'sourceName' => '<string>',
            'terraformSource' => [
                's3StateFileUrl' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppVersionAppComponents

$result = $client->listAppVersionAppComponents([/* ... */]);
$promise = $client->listAppVersionAppComponentsAsync([/* ... */]);

Lists all the Application Components in the Resilience Hub application.

Parameter Syntax

$result = $client->listAppVersionAppComponents([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appComponents' => [
        [
            'additionalInfo' => [
                '<String128WithoutWhitespace>' => ['<string>', ...],
                // ...
            ],
            'id' => '<string>',
            'name' => '<string>',
            'type' => '<string>',
        ],
        // ...
    ],
    'appVersion' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppVersionResourceMappings

$result = $client->listAppVersionResourceMappings([/* ... */]);
$promise = $client->listAppVersionResourceMappingsAsync([/* ... */]);

Lists how the resources in an application version are mapped/sourced from. Mappings can be physical resource identifiers, CloudFormation stacks, resource-groups, or an application registry app.

Parameter Syntax

$result = $client->listAppVersionResourceMappings([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resourceMappings' => [
        [
            'appRegistryAppName' => '<string>',
            'eksSourceName' => '<string>',
            'logicalStackName' => '<string>',
            'mappingType' => 'CfnStack|Resource|AppRegistryApp|ResourceGroup|Terraform|EKS',
            'physicalResourceId' => [
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>',
                'type' => 'Arn|Native',
            ],
            'resourceGroupName' => '<string>',
            'resourceName' => '<string>',
            'terraformSourceName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppVersionResources

$result = $client->listAppVersionResources([/* ... */]);
$promise = $client->listAppVersionResourcesAsync([/* ... */]);

Lists all the resources in an Resilience Hub application.

Parameter Syntax

$result = $client->listAppVersionResources([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resolutionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'physicalResources' => [
        [
            'additionalInfo' => [
                '<String128WithoutWhitespace>' => ['<string>', ...],
                // ...
            ],
            'appComponents' => [
                [
                    'additionalInfo' => [
                        '<String128WithoutWhitespace>' => ['<string>', ...],
                        // ...
                    ],
                    'id' => '<string>',
                    'name' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'excluded' => true || false,
            'logicalResourceId' => [
                'eksSourceName' => '<string>',
                'identifier' => '<string>',
                'logicalStackName' => '<string>',
                'resourceGroupName' => '<string>',
                'terraformSourceName' => '<string>',
            ],
            'parentResourceName' => '<string>',
            'physicalResourceId' => [
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>',
                'type' => 'Arn|Native',
            ],
            'resourceName' => '<string>',
            'resourceType' => '<string>',
            'sourceType' => 'AppTemplate|Discovered',
        ],
        // ...
    ],
    'resolutionId' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListAppVersions

$result = $client->listAppVersions([/* ... */]);
$promise = $client->listAppVersionsAsync([/* ... */]);

Lists the different versions for the Resilience Hub applications.

Parameter Syntax

$result = $client->listAppVersions([
    'appArn' => '<string>', // REQUIRED
    'endTime' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'startTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'appVersions' => [
        [
            'appVersion' => '<string>',
            'creationTime' => <DateTime>,
            'identifier' => <integer>,
            'versionName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ValidationException:

This exception occurs when a request is not valid.

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.

ListApps

$result = $client->listApps([/* ... */]);
$promise = $client->listAppsAsync([/* ... */]);

Lists your Resilience Hub applications.

Parameter Syntax

$result = $client->listApps([
    'appArn' => '<string>',
    'awsApplicationArn' => '<string>',
    'fromLastAssessmentTime' => <integer || string || DateTime>,
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'reverseOrder' => true || false,
    'toLastAssessmentTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'appSummaries' => [
        [
            'appArn' => '<string>',
            'assessmentSchedule' => 'Disabled|Daily',
            'awsApplicationArn' => '<string>',
            'complianceStatus' => 'PolicyBreached|PolicyMet|NotAssessed|ChangesDetected|NotApplicable|MissingPolicy',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'driftStatus' => 'NotChecked|NotDetected|Detected',
            'lastAppComplianceEvaluationTime' => <DateTime>,
            'name' => '<string>',
            'resiliencyScore' => <float>,
            'rpoInSecs' => <integer>,
            'rtoInSecs' => <integer>,
            'status' => 'Active|Deleting',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListMetrics

$result = $client->listMetrics([/* ... */]);
$promise = $client->listMetricsAsync([/* ... */]);

Lists the metrics that can be exported.

Parameter Syntax

$result = $client->listMetrics([
    'conditions' => [
        [
            'field' => '<string>', // REQUIRED
            'operator' => 'Equals|NotEquals|GreaterThen|GreaterOrEquals|LessThen|LessOrEquals', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'dataSource' => '<string>',
    'fields' => [
        [
            'aggregation' => 'Min|Max|Sum|Avg|Count',
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sorts' => [
        [
            'ascending' => true || false,
            'field' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'rows' => [
        ['<string>', ...],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListRecommendationTemplates

$result = $client->listRecommendationTemplates([/* ... */]);
$promise = $client->listRecommendationTemplatesAsync([/* ... */]);

Lists the recommendation templates for the Resilience Hub applications.

Parameter Syntax

$result = $client->listRecommendationTemplates([
    'assessmentArn' => '<string>',
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'recommendationTemplateArn' => '<string>',
    'reverseOrder' => true || false,
    'status' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'recommendationTemplates' => [
        [
            'appArn' => '<string>',
            'assessmentArn' => '<string>',
            'endTime' => <DateTime>,
            'format' => 'CfnYaml|CfnJson',
            'message' => '<string>',
            'name' => '<string>',
            'needsReplacements' => true || false,
            'recommendationIds' => ['<string>', ...],
            'recommendationTemplateArn' => '<string>',
            'recommendationTypes' => ['<string>', ...],
            'startTime' => <DateTime>,
            'status' => 'Pending|InProgress|Failed|Success',
            'tags' => ['<string>', ...],
            'templatesLocation' => [
                'bucket' => '<string>',
                'prefix' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListResiliencyPolicies

$result = $client->listResiliencyPolicies([/* ... */]);
$promise = $client->listResiliencyPoliciesAsync([/* ... */]);

Lists the resiliency policies for the Resilience Hub applications.

Parameter Syntax

$result = $client->listResiliencyPolicies([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'policyName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resiliencyPolicies' => [
        [
            'creationTime' => <DateTime>,
            'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
            'estimatedCostTier' => 'L1|L2|L3|L4',
            'policy' => [
                '<DisruptionType>' => [
                    'rpoInSecs' => <integer>,
                    'rtoInSecs' => <integer>,
                ],
                // ...
            ],
            'policyArn' => '<string>',
            'policyDescription' => '<string>',
            'policyName' => '<string>',
            'tags' => ['<string>', ...],
            'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical|NotApplicable',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListResourceGroupingRecommendations

$result = $client->listResourceGroupingRecommendations([/* ... */]);
$promise = $client->listResourceGroupingRecommendationsAsync([/* ... */]);

Lists the resource grouping recommendations suggested by Resilience Hub for your application.

Parameter Syntax

$result = $client->listResourceGroupingRecommendations([
    'appArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'groupingRecommendations' => [
        [
            'confidenceLevel' => 'High|Medium',
            'creationTime' => <DateTime>,
            'groupingAppComponent' => [
                'appComponentId' => '<string>',
                'appComponentName' => '<string>',
                'appComponentType' => '<string>',
            ],
            'groupingRecommendationId' => '<string>',
            'recommendationReasons' => ['<string>', ...],
            'rejectionReason' => 'DistinctBusinessPurpose|SeparateDataConcern|DistinctUserGroupHandling|Other',
            'resources' => [
                [
                    'logicalResourceId' => [
                        'eksSourceName' => '<string>',
                        'identifier' => '<string>',
                        'logicalStackName' => '<string>',
                        'resourceGroupName' => '<string>',
                        'terraformSourceName' => '<string>',
                    ],
                    'physicalResourceId' => [
                        'awsAccountId' => '<string>',
                        'awsRegion' => '<string>',
                        'identifier' => '<string>',
                        'type' => 'Arn|Native',
                    ],
                    'resourceName' => '<string>',
                    'resourceType' => '<string>',
                    'sourceAppComponentIds' => ['<string>', ...],
                ],
                // ...
            ],
            'score' => <float>,
            'status' => 'Accepted|Rejected|PendingDecision',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListSopRecommendations

$result = $client->listSopRecommendations([/* ... */]);
$promise = $client->listSopRecommendationsAsync([/* ... */]);

Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.

Parameter Syntax

$result = $client->listSopRecommendations([
    'assessmentArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sopRecommendations' => [
        [
            'appComponentName' => '<string>',
            'description' => '<string>',
            'items' => [
                [
                    'alreadyImplemented' => true || false,
                    'discoveredAlarm' => [
                        'alarmArn' => '<string>',
                        'source' => '<string>',
                    ],
                    'excludeReason' => 'AlreadyImplemented|NotRelevant|ComplexityOfImplementation',
                    'excluded' => true || false,
                    'latestDiscoveredExperiment' => [
                        'experimentArn' => '<string>',
                        'experimentTemplateId' => '<string>',
                    ],
                    'resourceId' => '<string>',
                    'targetAccountId' => '<string>',
                    'targetRegion' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'prerequisite' => '<string>',
            'recommendationId' => '<string>',
            'recommendationStatus' => 'Implemented|Inactive|NotImplemented|Excluded',
            'referenceId' => '<string>',
            'serviceType' => 'SSM',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListSuggestedResiliencyPolicies

$result = $client->listSuggestedResiliencyPolicies([/* ... */]);
$promise = $client->listSuggestedResiliencyPoliciesAsync([/* ... */]);

Lists the suggested resiliency policies for the Resilience Hub applications.

Parameter Syntax

$result = $client->listSuggestedResiliencyPolicies([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resiliencyPolicies' => [
        [
            'creationTime' => <DateTime>,
            'dataLocationConstraint' => 'AnyLocation|SameContinent|SameCountry',
            'estimatedCostTier' => 'L1|L2|L3|L4',
            'policy' => [
                '<DisruptionType>' => [
                    'rpoInSecs' => <integer>,
                    'rtoInSecs' => <integer>,
                ],
                // ...
            ],
            'policyArn' => '<string>',
            'policyDescription' => '<string>',
            'policyName' => '<string>',
            'tags' => ['<string>', ...],
            'tier' => 'MissionCritical|Critical|Important|CoreServices|NonCritical|NotApplicable',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for your resources in your Resilience Hub applications.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListTestRecommendations

$result = $client->listTestRecommendations([/* ... */]);
$promise = $client->listTestRecommendationsAsync([/* ... */]);

Lists the test recommendations for the Resilience Hub application.

Parameter Syntax

$result = $client->listTestRecommendations([
    'assessmentArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'testRecommendations' => [
        [
            'appComponentId' => '<string>',
            'appComponentName' => '<string>',
            'dependsOnAlarms' => ['<string>', ...],
            'description' => '<string>',
            'intent' => '<string>',
            'items' => [
                [
                    'alreadyImplemented' => true || false,
                    'discoveredAlarm' => [
                        'alarmArn' => '<string>',
                        'source' => '<string>',
                    ],
                    'excludeReason' => 'AlreadyImplemented|NotRelevant|ComplexityOfImplementation',
                    'excluded' => true || false,
                    'latestDiscoveredExperiment' => [
                        'experimentArn' => '<string>',
                        'experimentTemplateId' => '<string>',
                    ],
                    'resourceId' => '<string>',
                    'targetAccountId' => '<string>',
                    'targetRegion' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'prerequisite' => '<string>',
            'recommendationId' => '<string>',
            'recommendationStatus' => 'Implemented|Inactive|NotImplemented|Excluded',
            'referenceId' => '<string>',
            'risk' => 'Small|Medium|High',
            'type' => 'Software|Hardware|AZ|Region',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

ListUnsupportedAppVersionResources

$result = $client->listUnsupportedAppVersionResources([/* ... */]);
$promise = $client->listUnsupportedAppVersionResourcesAsync([/* ... */]);

Lists the resources that are not currently supported in Resilience Hub. An unsupported resource is a resource that exists in the object that was used to create an app, but is not supported by Resilience Hub.

Parameter Syntax

$result = $client->listUnsupportedAppVersionResources([
    'appArn' => '<string>', // REQUIRED
    'appVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resolutionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resolutionId' => '<string>',
    'unsupportedResources' => [
        [
            'logicalResourceId' => [
                'eksSourceName' => '<string>',
                'identifier' => '<string>',
                'logicalStackName' => '<string>',
                'resourceGroupName' => '<string>',
                'terraformSourceName' => '<string>',
            ],
            'physicalResourceId' => [
                'awsAccountId' => '<string>',
                'awsRegion' => '<string>',
                'identifier' => '<string>',
                'type' => 'Arn|Native',
            ],
            'resourceType' => '<string>',
            'unsupportedResourceStatus' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

PublishAppVersion

$result = $client->publishAppVersion([/* ... */]);
$promise = $client->publishAppVersionAsync([/* ... */]);

Publishes a new version of a specific Resilience Hub application.

Parameter Syntax

$result = $client->publishAppVersion([
    'appArn' => '<string>', // REQUIRED
    'versionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
    'identifier' => <integer>,
    'versionName' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

PutDraftAppVersionTemplate

$result = $client->putDraftAppVersionTemplate([/* ... */]);
$promise = $client->putDraftAppVersionTemplateAsync([/* ... */]);

Adds or updates the app template for an Resilience Hub application draft version.

Parameter Syntax

$result = $client->putDraftAppVersionTemplate([
    'appArn' => '<string>', // REQUIRED
    'appTemplateBody' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appVersion' => '<string>',
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

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.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.

RejectResourceGroupingRecommendations

$result = $client->rejectResourceGroupingRecommendations([/* ... */]);
$promise = $client->rejectResourceGroupingRecommendationsAsync([/* ... */]);

Rejects resource grouping recommendations.

Parameter Syntax

$result = $client->rejectResourceGroupingRecommendations([
    'appArn' => '<string>', // REQUIRED
    'entries' => [ // REQUIRED
        [
            'groupingRecommendationId' => '<string>', // REQUIRED
            'rejectionReason' => 'DistinctBusinessPurpose|SeparateDataConcern|DistinctUserGroupHandling|Other',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'failedEntries' => [
        [
            'errorMessage' => '<string>',
            'groupingRecommendationId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

This exception occurs when there is an internal failure in the Resilience Hub service.

ResourceNotFoundException:

This exception occurs when the specified resource could not be found.

ThrottlingException:

This exception occurs when you have exceeded the limit on the number of requests per second.

ValidationException:

This exception occurs when a request is not valid.

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.