ACMPCA / Paginator / ListCertificateAuthorities

ListCertificateAuthorities#

class ACMPCA.Paginator.ListCertificateAuthorities#

paginator = client.get_paginator('list_certificate_authorities')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from ACMPCA.Client.list_certificate_authorities().

Request Syntax

response_iterator = paginator.paginate(
    ResourceOwner='SELF'|'OTHER_ACCOUNTS',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

ResourceOwner (string) – Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'CertificateAuthorities': [
        {
            'Arn': 'string',
            'OwnerAccount': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastStateChangeAt': datetime(2015, 1, 1),
            'Type': 'ROOT'|'SUBORDINATE',
            'Serial': 'string',
            'Status': 'CREATING'|'PENDING_CERTIFICATE'|'ACTIVE'|'DELETED'|'DISABLED'|'EXPIRED'|'FAILED',
            'NotBefore': datetime(2015, 1, 1),
            'NotAfter': datetime(2015, 1, 1),
            'FailureReason': 'REQUEST_TIMED_OUT'|'UNSUPPORTED_ALGORITHM'|'OTHER',
            'CertificateAuthorityConfiguration': {
                'KeyAlgorithm': 'RSA_2048'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1',
                'SigningAlgorithm': 'SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA',
                'Subject': {
                    'Country': 'string',
                    'Organization': 'string',
                    'OrganizationalUnit': 'string',
                    'DistinguishedNameQualifier': 'string',
                    'State': 'string',
                    'CommonName': 'string',
                    'SerialNumber': 'string',
                    'Locality': 'string',
                    'Title': 'string',
                    'Surname': 'string',
                    'GivenName': 'string',
                    'Initials': 'string',
                    'Pseudonym': 'string',
                    'GenerationQualifier': 'string',
                    'CustomAttributes': [
                        {
                            'ObjectIdentifier': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'CsrExtensions': {
                    'KeyUsage': {
                        'DigitalSignature': True|False,
                        'NonRepudiation': True|False,
                        'KeyEncipherment': True|False,
                        'DataEncipherment': True|False,
                        'KeyAgreement': True|False,
                        'KeyCertSign': True|False,
                        'CRLSign': True|False,
                        'EncipherOnly': True|False,
                        'DecipherOnly': True|False
                    },
                    'SubjectInformationAccess': [
                        {
                            'AccessMethod': {
                                'CustomObjectIdentifier': 'string',
                                'AccessMethodType': 'CA_REPOSITORY'|'RESOURCE_PKI_MANIFEST'|'RESOURCE_PKI_NOTIFY'
                            },
                            'AccessLocation': {
                                'OtherName': {
                                    'TypeId': 'string',
                                    'Value': 'string'
                                },
                                'Rfc822Name': 'string',
                                'DnsName': 'string',
                                'DirectoryName': {
                                    'Country': 'string',
                                    'Organization': 'string',
                                    'OrganizationalUnit': 'string',
                                    'DistinguishedNameQualifier': 'string',
                                    'State': 'string',
                                    'CommonName': 'string',
                                    'SerialNumber': 'string',
                                    'Locality': 'string',
                                    'Title': 'string',
                                    'Surname': 'string',
                                    'GivenName': 'string',
                                    'Initials': 'string',
                                    'Pseudonym': 'string',
                                    'GenerationQualifier': 'string',
                                    'CustomAttributes': [
                                        {
                                            'ObjectIdentifier': 'string',
                                            'Value': 'string'
                                        },
                                    ]
                                },
                                'EdiPartyName': {
                                    'PartyName': 'string',
                                    'NameAssigner': 'string'
                                },
                                'UniformResourceIdentifier': 'string',
                                'IpAddress': 'string',
                                'RegisteredId': 'string'
                            }
                        },
                    ]
                }
            },
            'RevocationConfiguration': {
                'CrlConfiguration': {
                    'Enabled': True|False,
                    'ExpirationInDays': 123,
                    'CustomCname': 'string',
                    'S3BucketName': 'string',
                    'S3ObjectAcl': 'PUBLIC_READ'|'BUCKET_OWNER_FULL_CONTROL',
                    'CrlDistributionPointExtensionConfiguration': {
                        'OmitExtension': True|False
                    }
                },
                'OcspConfiguration': {
                    'Enabled': True|False,
                    'OcspCustomCname': 'string'
                }
            },
            'RestorableUntil': datetime(2015, 1, 1),
            'KeyStorageSecurityStandard': 'FIPS_140_2_LEVEL_2_OR_HIGHER'|'FIPS_140_2_LEVEL_3_OR_HIGHER',
            'UsageMode': 'GENERAL_PURPOSE'|'SHORT_LIVED_CERTIFICATE'
        },
    ],

}

Response Structure

(dict) –
- CertificateAuthorities (list) –
  
  Summary information about each certificate authority you have created.
  - (dict) –
    
    Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM).
    - Arn (string) –
      
      Amazon Resource Name (ARN) for your private certificate authority (CA). The format is ``12345678-1234-1234-1234-123456789012 ``.
    - OwnerAccount (string) –
      
      The Amazon Web Services account ID that owns the certificate authority.
    - CreatedAt (datetime) –
      
      Date and time at which your private CA was created.
    - LastStateChangeAt (datetime) –
      
      Date and time at which your private CA was last updated.
    - Type (string) –
      
      Type of your private CA.
    - Serial (string) –
      
      Serial number of your private CA.
    - Status (string) –
      
      Status of your private CA.
    - NotBefore (datetime) –
      
      Date and time before which your private CA certificate is not valid.
    - NotAfter (datetime) –
      
      Date and time after which your private CA certificate is not valid.
    - FailureReason (string) –
      
      Reason the request to create your private CA failed.
    - CertificateAuthorityConfiguration (dict) –
      
      Your private CA configuration.
      - KeyAlgorithm (string) –
        
        Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
      - SigningAlgorithm (string) –
        
        Name of the algorithm your private CA uses to sign certificate requests.
        
        This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.
      - Subject (dict) –
        
        Structure that contains X.500 distinguished name information for your private CA.
        
        Country (string) –
        
        Two-digit code that specifies the country in which the certificate subject located.
        
        Organization (string) –
        
        Legal name of the organization with which the certificate subject is affiliated.
        
        OrganizationalUnit (string) –
        
        A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
        
        DistinguishedNameQualifier (string) –
        
        Disambiguating information for the certificate subject.
        
        State (string) –
        
        State in which the subject of the certificate is located.
        
        CommonName (string) –
        
        For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.
        
        Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.
        
        SerialNumber (string) –
        
        The certificate serial number.
        
        Locality (string) –
        
        The locality (such as a city or town) in which the certificate subject is located.
        
        Title (string) –
        
        A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
        
        Surname (string) –
        
        Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
        
        GivenName (string) –
        
        First name.
        
        Initials (string) –
        
        Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.
        
        Pseudonym (string) –
        
        Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
        
        GenerationQualifier (string) –
        
        Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
        
        CustomAttributes (list) –
        
        Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).
        
        Note
        Custom attributes cannot be used in combination with standard attributes.
        
        (dict) –
        
        Defines the X.500 relative distinguished name (RDN).
        
        ObjectIdentifier (string) –
        
        Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
        
        Value (string) –
        
        Specifies the attribute value of relative distinguished name (RDN).
      - CsrExtensions (dict) –
        
        Specifies information to be added to the extension section of the certificate signing request (CSR).
        
        KeyUsage (dict) –
        
        Indicates the purpose of the certificate and of the key contained in the certificate.
        
        DigitalSignature (boolean) –
        
        Key can be used for digital signing.
        
        NonRepudiation (boolean) –
        
        Key can be used for non-repudiation.
        
        KeyEncipherment (boolean) –
        
        Key can be used to encipher data.
        
        DataEncipherment (boolean) –
        
        Key can be used to decipher data.
        
        KeyAgreement (boolean) –
        
        Key can be used in a key-agreement protocol.
        
        KeyCertSign (boolean) –
        
        Key can be used to sign certificates.
        
        CRLSign (boolean) –
        
        Key can be used to sign CRLs.
        
        EncipherOnly (boolean) –
        
        Key can be used only to encipher data.
        
        DecipherOnly (boolean) –
        
        Key can be used only to decipher data.
        
        SubjectInformationAccess (list) –
        
        For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.
        
        (dict) –
        
        Provides access information used by the authorityInfoAccess and subjectInfoAccess extensions described in RFC 5280.
        
        AccessMethod (dict) –
        
        The type and format of AccessDescription information.
        
        CustomObjectIdentifier (string) –
        
        An object identifier (OID) specifying the AccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST’s definition of Object Identifier (OID).
        
        AccessMethodType (string) –
        
        Specifies the AccessMethod.
        
        AccessLocation (dict) –
        
        The location of AccessDescription information.
        
        OtherName (dict) –
        
        Represents GeneralName using an OtherName object.
        
        TypeId (string) –
        
        Specifies an OID.
        
        Value (string) –
        
        Specifies an OID value.
        
        Rfc822Name (string) –
        
        Represents GeneralName as an RFC 822 email address.
        
        DnsName (string) –
        
        Represents GeneralName as a DNS name.
        
        DirectoryName (dict) –
        
        Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The ``Subject ``must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.
        
        Country (string) –
        
        Two-digit code that specifies the country in which the certificate subject located.
        
        Organization (string) –
        
        Legal name of the organization with which the certificate subject is affiliated.
        
        OrganizationalUnit (string) –
        
        A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
        
        DistinguishedNameQualifier (string) –
        
        Disambiguating information for the certificate subject.
        
        State (string) –
        
        State in which the subject of the certificate is located.
        
        CommonName (string) –
        
        For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.
        
        Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.
        
        SerialNumber (string) –
        
        The certificate serial number.
        
        Locality (string) –
        
        The locality (such as a city or town) in which the certificate subject is located.
        
        Title (string) –
        
        A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
        
        Surname (string) –
        
        Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
        
        GivenName (string) –
        
        First name.
        
        Initials (string) –
        
        Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.
        
        Pseudonym (string) –
        
        Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
        
        GenerationQualifier (string) –
        
        Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
        
        CustomAttributes (list) –
        
        Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).
        
        Note
        Custom attributes cannot be used in combination with standard attributes.
        
        (dict) –
        
        Defines the X.500 relative distinguished name (RDN).
        
        ObjectIdentifier (string) –
        
        Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
        
        Value (string) –
        
        Specifies the attribute value of relative distinguished name (RDN).
        
        EdiPartyName (dict) –
        
        Represents GeneralName as an EdiPartyName object.
        
        PartyName (string) –
        
        Specifies the party name.
        
        NameAssigner (string) –
        
        Specifies the name assigner.
        
        UniformResourceIdentifier (string) –
        
        Represents GeneralName as a URI.
        
        IpAddress (string) –
        
        Represents GeneralName as an IPv4 or IPv6 address.
        
        RegisteredId (string) –
        
        Represents GeneralName as an object identifier (OID).
    - RevocationConfiguration (dict) –
      
      Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.
      - CrlConfiguration (dict) –
        
        Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.
        
        Enabled (boolean) –
        
        Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.
        
        ExpirationInDays (integer) –
        
        Validity period of the CRL in days.
        
        CustomCname (string) –
        
        Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don’t want the name of your S3 bucket to be public.
        
        Note
        The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as “http://” or “https://”.
        
        S3BucketName (string) –
        
        Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket.
        
        Note
        The S3BucketName parameter must conform to the S3 bucket naming rules.
        
        S3ObjectAcl (string) –
        
        Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.
        
        If no value is specified, the default is PUBLIC_READ.
        
        Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.
        
        For more information, see Blocking public access to the S3 bucket.
        
        CrlDistributionPointExtensionConfiguration (dict) –
        
        Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL.
        
        OmitExtension (boolean) –
        
        Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.
        
        Note
        Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger
        
        This configuration cannot be enabled with a custom CNAME set.
      - OcspConfiguration (dict) –
        
        Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.
        
        Enabled (boolean) –
        
        Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
        
        OcspCustomCname (string) –
        
        By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.
        
        Note
        The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as “http://” or “https://”.
        
        For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.
    - RestorableUntil (datetime) –
      
      The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
    - KeyStorageSecurityStandard (string) –
      
      Defines a cryptographic key management compliance standard used for handling CA keys.
      
      Default: FIPS_140_2_LEVEL_3_OR_HIGHER
      
      Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message “A certificate authority cannot be created in this region with the specified security standard.”
    - UsageMode (string) –
      
      Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
      
      The default value is GENERAL_PURPOSE.