SMS / Client / get_app_replication_configuration

get_app_replication_configuration#

SMS.Client.get_app_replication_configuration(**kwargs)#

Retrieves the application replication configuration associated with the specified application.

See also: AWS API Documentation

Request Syntax

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

appId (string) – The ID of the application.

Return type:

dict

Returns:

Response Syntax

{
    'serverGroupReplicationConfigurations': [
        {
            'serverGroupId': 'string',
            'serverReplicationConfigurations': [
                {
                    '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
                    },
                    'serverReplicationParameters': {
                        'seedTime': datetime(2015, 1, 1),
                        'frequency': 123,
                        'runOnce': True|False,
                        'licenseType': 'AWS'|'BYOL',
                        'numberOfRecentAmisToKeep': 123,
                        'encrypted': True|False,
                        'kmsKeyId': 'string'
                    }
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • serverGroupReplicationConfigurations (list) –

      The replication configurations associated with server groups in this application.

      • (dict) –

        Replication configuration for a server group.

        • serverGroupId (string) –

          The ID of the server group with which this replication configuration is associated.

        • serverReplicationConfigurations (list) –

          The replication configuration for servers in the server group.

          • (dict) –

            Replication configuration of a server.

            • server (dict) –

              The ID of the server with which this replication configuration is associated.

              • 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.

            • serverReplicationParameters (dict) –

              The parameters for replicating the server.

              • seedTime (datetime) –

                The seed time for creating a replication job for the server.

              • frequency (integer) –

                The frequency of creating replication jobs for the server.

              • runOnce (boolean) –

                Indicates whether to run the replication job one time.

              • licenseType (string) –

                The license type for creating a replication job for the server.

              • numberOfRecentAmisToKeep (integer) –

                The number of recent AMIs to keep when creating a replication job for this server.

              • encrypted (boolean) –

                Indicates whether the replication job produces encrypted AMIs.

              • kmsKeyId (string) –

                The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

                • KMS key ID

                • KMS key alias

                • ARN referring to the KMS key ID

                • ARN referring to the KMS key alias

                If encrypted is enabled but a KMS key ID is not specified, the customer’s default KMS key for Amazon EBS is used.

Exceptions