ResilienceHub / Client / batch_update_recommendation_status

batch_update_recommendation_status#

ResilienceHub.Client.batch_update_recommendation_status(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.batch_update_recommendation_status(
    appArn='string',
    requestEntries=[
        {
            'appComponentId': 'string',
            'entryId': 'string',
            'excludeReason': 'AlreadyImplemented'|'NotRelevant'|'ComplexityOfImplementation',
            'excluded': True|False,
            'item': {
                'resourceId': 'string',
                'targetAccountId': 'string',
                'targetRegion': 'string'
            },
            'referenceId': 'string'
        },
    ]
)
Parameters:

  • appArn (string) –

    [REQUIRED]

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: partition:resiliencehub: region: account:app/ app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • requestEntries (list) –

    [REQUIRED]

    Defines the list of operational recommendations that need to be included or excluded.

    • (dict) –

      Defines the operational recommendation item that is to be included or excluded.

      • appComponentId (string) –

        Indicates the identifier of the AppComponent.

      • entryId (string) – [REQUIRED]

        An identifier for an entry in this batch that is used to communicate the result.

        Note

        The ``entryId``s of a batch request need to be unique within a request.

      • excludeReason (string) –

        Indicates the reason for excluding an operational recommendation.

      • excluded (boolean) – [REQUIRED]

        Indicates if the operational recommendation needs to be excluded. If set to True, the operational recommendation will be excluded.

      • item (dict) –

        The operational recommendation item.

        • resourceId (string) –

          Resource identifier of the operational recommendation item.

        • targetAccountId (string) –

          Identifier of the target Amazon Web Services account.

        • targetRegion (string) –

          Identifier of the target Amazon Web Services Region.

      • referenceId (string) – [REQUIRED]

        Reference identifier of the operational recommendation item.

Return type:

dict

Returns:

Response 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'
        },
    ]
}

Response Structure

  • (dict) –

    • appArn (string) –

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: partition:resiliencehub: region: account:app/ app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • failedEntries (list) –

      A list of items with error details about each item, which could not be included or excluded.

      • (dict) –

        List of operational recommendations that did not get included or excluded.

        • entryId (string) –

          An identifier of an entry in this batch that is used to communicate the result.

          Note

          The ``entryId``s of a batch request need to be unique within a request.

        • errorMessage (string) –

          Indicates the error that occurred while excluding an operational recommendation.

    • successfulEntries (list) –

      A list of items that were included or excluded.

      • (dict) –

        List of operational recommendations that were successfully included or excluded.

        • appComponentId (string) –

          Indicates the identifier of an AppComponent.

        • entryId (string) –

          An identifier for an entry in this batch that is used to communicate the result.

          Note

          The ``entryId``s of a batch request need to be unique within a request.

        • excludeReason (string) –

          Indicates the reason for excluding an operational recommendation.

        • excluded (boolean) –

          Indicates if the operational recommendation was successfully excluded.

        • item (dict) –

          The operational recommendation item.

          • resourceId (string) –

            Resource identifier of the operational recommendation item.

          • targetAccountId (string) –

            Identifier of the target Amazon Web Services account.

          • targetRegion (string) –

            Identifier of the target Amazon Web Services Region.

        • referenceId (string) –

          Reference identifier of the operational recommendation.

Exceptions