AWS IoT

{'certificateDescription': {'customerVersion': 'integer',
                            'generationId': 'string',
                            'lastModifiedDate': 'timestamp'}}

Describes a registered CA certificate.

See also: AWS API Documentation

Request Syntax

client.describe_ca_certificate(
    certificateId='string'
)

type certificateId:

string

param certificateId:

[REQUIRED]

The CA certificate identifier.

rtype:

dict

returns:

Response Syntax

{
    'certificateDescription': {
        'certificateArn': 'string',
        'certificateId': 'string',
        'status': 'ACTIVE'|'INACTIVE',
        'certificatePem': 'string',
        'ownedBy': 'string',
        'creationDate': datetime(2015, 1, 1),
        'autoRegistrationStatus': 'ENABLE'|'DISABLE',
        'lastModifiedDate': datetime(2015, 1, 1),
        'customerVersion': 123,
        'generationId': 'string'
    },
    'registrationConfig': {
        'templateBody': 'string',
        'roleArn': 'string'
    }
}

Response Structure

• (dict) --

  The output from the DescribeCACertificate operation.

  • certificateDescription (dict) --

    The CA certificate description.

    • certificateArn (string) --

      The CA certificate ARN.

    • certificateId (string) --

      The CA certificate ID.

    • status (string) --

      The status of a CA certificate.

    • certificatePem (string) --

      The CA certificate data, in PEM format.

    • ownedBy (string) --

      The owner of the CA certificate.

    • creationDate (datetime) --

      The date the CA certificate was created.

    • autoRegistrationStatus (string) --

      Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"

    • lastModifiedDate (datetime) --

    • customerVersion (integer) --

    • generationId (string) --

  • registrationConfig (dict) --

    Information about the registration configuration.

    • templateBody (string) --

      The template body.

    • roleArn (string) --

      The ARN of the role.

{'certificateDescription': {'customerVersion': 'integer',
                            'generationId': 'string'}}

Gets information about the specified certificate.

See also: AWS API Documentation

Request Syntax

client.describe_certificate(
    certificateId='string'
)

type certificateId:

string

param certificateId:

[REQUIRED]

The ID of the certificate.

rtype:

dict

returns:

Response Syntax

{
    'certificateDescription': {
        'certificateArn': 'string',
        'certificateId': 'string',
        'caCertificateId': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'REVOKED'|'PENDING_TRANSFER'|'REGISTER_INACTIVE'|'PENDING_ACTIVATION',
        'certificatePem': 'string',
        'ownedBy': 'string',
        'previousOwnedBy': 'string',
        'creationDate': datetime(2015, 1, 1),
        'lastModifiedDate': datetime(2015, 1, 1),
        'customerVersion': 123,
        'transferData': {
            'transferMessage': 'string',
            'rejectReason': 'string',
            'transferDate': datetime(2015, 1, 1),
            'acceptDate': datetime(2015, 1, 1),
            'rejectDate': datetime(2015, 1, 1)
        },
        'generationId': 'string'
    }
}

Response Structure

• (dict) --

  The output of the DescribeCertificate operation.

  • certificateDescription (dict) --

    The description of the certificate.

    • certificateArn (string) --

      The ARN of the certificate.

    • certificateId (string) --

      The ID of the certificate.

    • caCertificateId (string) --

      The certificate ID of the CA certificate used to sign this certificate.

    • status (string) --

      The status of the certificate.

    • certificatePem (string) --

      The certificate data, in PEM format.

    • ownedBy (string) --

      The ID of the AWS account that owns the certificate.

    • previousOwnedBy (string) --

      The ID of the AWS account of the previous owner of the certificate.

    • creationDate (datetime) --

      The date and time the certificate was created.

    • lastModifiedDate (datetime) --

      The date and time the certificate was last modified.

    • customerVersion (integer) --

    • transferData (dict) --

      The transfer data.

      • transferMessage (string) --

        The transfer message.

      • rejectReason (string) --

        The reason why the transfer was rejected.

      • transferDate (datetime) --

        The date the transfer took place.

      • acceptDate (datetime) --

        The date the transfer was accepted.

      • rejectDate (datetime) --

        The date the transfer was rejected.

    • generationId (string) --

{'roleAliasDescription': {'roleAliasArn': 'string'}}

Describes a role alias.

See also: AWS API Documentation

Request Syntax

client.describe_role_alias(
    roleAlias='string'
)

type roleAlias:

string

param roleAlias:

[REQUIRED]

The role alias to describe.

rtype:

dict

returns:

Response Syntax

{
    'roleAliasDescription': {
        'roleAlias': 'string',
        'roleAliasArn': 'string',
        'roleArn': 'string',
        'owner': 'string',
        'credentialDurationSeconds': 123,
        'creationDate': datetime(2015, 1, 1),
        'lastModifiedDate': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • roleAliasDescription (dict) --

    The role alias description.

    • roleAlias (string) --

      The role alias.

    • roleAliasArn (string) --

    • roleArn (string) --

      The role ARN.

    • owner (string) --

      The role alias owner.

    • credentialDurationSeconds (integer) --

      The number of seconds for which the credential is valid.

    • creationDate (datetime) --

      The UNIX timestamp of when the role alias was created.

    • lastModifiedDate (datetime) --

      The UNIX timestamp of when the role alias was last modified.

{'creationDate': 'timestamp',
 'generationId': 'string',
 'lastModifiedDate': 'timestamp'}

Gets information about the specified policy with the policy document of the default version.

See also: AWS API Documentation

Request Syntax

client.get_policy(
    policyName='string'
)

type policyName:

string

param policyName:

[REQUIRED]

The name of the policy.

rtype:

dict

returns:

Response Syntax

{
    'policyName': 'string',
    'policyArn': 'string',
    'policyDocument': 'string',
    'defaultVersionId': 'string',
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'generationId': 'string'
}

Response Structure

• (dict) --

  The output from the GetPolicy operation.

  • policyName (string) --

    The policy name.

  • policyArn (string) --

    The policy ARN.

  • policyDocument (string) --

    The JSON document that describes the policy.

  • defaultVersionId (string) --

    The default policy version ID.

  • creationDate (datetime) --

  • lastModifiedDate (datetime) --

  • generationId (string) --

{'creationDate': 'timestamp',
 'generationId': 'string',
 'lastModifiedDate': 'timestamp'}

Gets information about the specified policy version.

See also: AWS API Documentation

Request Syntax

client.get_policy_version(
    policyName='string',
    policyVersionId='string'
)

type policyName:

string

param policyName:

[REQUIRED]

The name of the policy.

type policyVersionId:

string

param policyVersionId:

[REQUIRED]

The policy version ID.

rtype:

dict

returns:

Response Syntax

{
    'policyArn': 'string',
    'policyName': 'string',
    'policyDocument': 'string',
    'policyVersionId': 'string',
    'isDefaultVersion': True|False,
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'generationId': 'string'
}

Response Structure

• (dict) --

  The output from the GetPolicyVersion operation.

  • policyArn (string) --

    The policy ARN.

  • policyName (string) --

    The policy name.

  • policyDocument (string) --

    The JSON document that describes the policy.

  • policyVersionId (string) --

    The policy version ID.

  • isDefaultVersion (boolean) --

    Specifies whether the policy version is the default.

  • creationDate (datetime) --

  • lastModifiedDate (datetime) --

  • generationId (string) --