DatabaseMigrationService / Client / describe_instance_profiles

describe_instance_profiles#

DatabaseMigrationService.Client.describe_instance_profiles(**kwargs)#

Returns a paginated list of instance profiles for your account in the current region.

See also: AWS API Documentation

Request Syntax

response = client.describe_instance_profiles(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • Filters (list) –

    Filters applied to the instance profiles described in the form of key-value pairs.

    • (dict) –

      Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

      • Name (string) – [REQUIRED]

        The name of the filter as specified for a Describe* or similar operation.

      • Values (list) – [REQUIRED]

        The filter value, which can specify one or more values used to narrow the returned results.

        • (string) –

  • MaxRecords (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

  • Marker (string) –

    Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'InstanceProfiles': [
        {
            'InstanceProfileArn': 'string',
            'AvailabilityZone': 'string',
            'KmsKeyArn': 'string',
            'PubliclyAccessible': True|False,
            'NetworkType': 'string',
            'InstanceProfileName': 'string',
            'Description': 'string',
            'InstanceProfileCreationTime': datetime(2015, 1, 1),
            'SubnetGroupIdentifier': 'string',
            'VpcSecurityGroups': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • InstanceProfiles (list) –

      A description of instance profiles.

      • (dict) –

        Provides information that defines an instance profile.

        • InstanceProfileArn (string) –

          The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.

        • AvailabilityZone (string) –

          The Availability Zone where the instance profile runs.

        • KmsKeyArn (string) –

          The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.

          If you don’t specify a value for the KmsKeyArn parameter, then DMS uses your default encryption key.

          KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

        • PubliclyAccessible (boolean) –

          Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.

        • NetworkType (string) –

          Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.

        • InstanceProfileName (string) –

          The user-friendly name for the instance profile.

        • Description (string) –

          A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

        • InstanceProfileCreationTime (datetime) –

          The time the instance profile was created.

        • SubnetGroupIdentifier (string) –

          The identifier of the subnet group that is associated with the instance profile.

        • VpcSecurityGroups (list) –

          The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.

          • (string) –

Exceptions

  • DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault

  • DatabaseMigrationService.Client.exceptions.AccessDeniedFault

  • DatabaseMigrationService.Client.exceptions.FailedDependencyFault