SMS / Client / get_app_validation_configuration

get_app_validation_configuration#

SMS.Client.get_app_validation_configuration(**kwargs)#

Retrieves information about a configuration for validating an application.

See also: AWS API Documentation

Request Syntax

response = client.get_app_validation_configuration(
    appId='string'
)
Parameters:

appId (string) –

[REQUIRED]

The ID of the application.

Return type:

dict

Returns:

Response Syntax

{
    'appValidationConfigurations': [
        {
            'validationId': 'string',
            'name': 'string',
            'appValidationStrategy': 'SSM',
            'ssmValidationParameters': {
                'source': {
                    's3Location': {
                        'bucket': 'string',
                        'key': 'string'
                    }
                },
                'instanceId': 'string',
                'scriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT',
                'command': 'string',
                'executionTimeoutSeconds': 123,
                'outputS3BucketName': 'string'
            }
        },
    ],
    'serverGroupValidationConfigurations': [
        {
            'serverGroupId': 'string',
            'serverValidationConfigurations': [
                {
                    'server': {
                        'serverId': 'string',
                        'serverType': 'VIRTUAL_MACHINE',
                        'vmServer': {
                            'vmServerAddress': {
                                'vmManagerId': 'string',
                                'vmId': 'string'
                            },
                            'vmName': 'string',
                            'vmManagerName': 'string',
                            'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
                            'vmPath': 'string'
                        },
                        'replicationJobId': 'string',
                        'replicationJobTerminated': True|False
                    },
                    'validationId': 'string',
                    'name': 'string',
                    'serverValidationStrategy': 'USERDATA',
                    'userDataValidationParameters': {
                        'source': {
                            's3Location': {
                                'bucket': 'string',
                                'key': 'string'
                            }
                        },
                        'scriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT'
                    }
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • appValidationConfigurations (list) –

      The configuration for application validation.

      • (dict) –

        Configuration for validating an application.

        • validationId (string) –

          The ID of the validation.

        • name (string) –

          The name of the configuration.

        • appValidationStrategy (string) –

          The validation strategy.

        • ssmValidationParameters (dict) –

          The validation parameters.

          • source (dict) –

            The location of the validation script.

            • s3Location (dict) –

              Location of an Amazon S3 object.

              • bucket (string) –

                The Amazon S3 bucket name.

              • key (string) –

                The Amazon S3 bucket key.

          • instanceId (string) –

            The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.

          • scriptType (string) –

            The type of validation script.

          • command (string) –

            The command to run the validation script.

          • executionTimeoutSeconds (integer) –

            The timeout interval, in seconds.

          • outputS3BucketName (string) –

            The name of the S3 bucket for output.

    • serverGroupValidationConfigurations (list) –

      The configuration for instance validation.

      • (dict) –

        Configuration for validating an instance.

        • serverGroupId (string) –

          The ID of the server group.

        • serverValidationConfigurations (list) –

          The validation configuration.

          • (dict) –

            Configuration for validating an instance.

            • server (dict) –

              Represents a server.

              • serverId (string) –

                The ID of the server.

              • serverType (string) –

                The type of server.

              • vmServer (dict) –

                Information about the VM server.

                • vmServerAddress (dict) –

                  The VM server location.

                  • vmManagerId (string) –

                    The ID of the VM manager.

                  • vmId (string) –

                    The ID of the VM.

                • vmName (string) –

                  The name of the VM.

                • vmManagerName (string) –

                  The name of the VM manager.

                • vmManagerType (string) –

                  The type of VM management product.

                • vmPath (string) –

                  The VM folder path in the vCenter Server virtual machine inventory tree.

              • replicationJobId (string) –

                The ID of the replication job.

              • replicationJobTerminated (boolean) –

                Indicates whether the replication job is deleted or failed.

            • validationId (string) –

              The ID of the validation.

            • name (string) –

              The name of the configuration.

            • serverValidationStrategy (string) –

              The validation strategy.

            • userDataValidationParameters (dict) –

              The validation parameters.

              • source (dict) –

                The location of the validation script.

                • s3Location (dict) –

                  Location of an Amazon S3 object.

                  • bucket (string) –

                    The Amazon S3 bucket name.

                  • key (string) –

                    The Amazon S3 bucket key.

              • scriptType (string) –

                The type of validation script.

Exceptions

  • SMS.Client.exceptions.UnauthorizedOperationException

  • SMS.Client.exceptions.InvalidParameterException

  • SMS.Client.exceptions.MissingRequiredParameterException

  • SMS.Client.exceptions.InternalError

  • SMS.Client.exceptions.OperationNotPermittedException