Class: Aws::PcaConnectorAd::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-pcaconnectorad/client.rb

Overview

An API client for PcaConnectorAd. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::PcaConnectorAd::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::PcaConnectorAd::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::PcaConnectorAd::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2349
2350
2351
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 2349

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2352
2353
2354
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 2352

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 2322

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::PcaConnectorAd')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-pcaconnectorad'
  context[:gem_version] = '1.29.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_connector(params = {}) ⇒ Types::CreateConnectorResponse

Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.

Examples:

Request syntax with placeholder values


resp = client.create_connector({
  certificate_authority_arn: "CertificateAuthorityArn", # required
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  tags: {
    "String" => "String",
  },
  vpc_information: { # required
    ip_address_type: "IPV4", # accepts IPV4, DUALSTACK
    security_group_ids: ["SecurityGroupId"], # required
  },
})

Response structure


resp.connector_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :certificate_authority_arn (required, String) —

    The Amazon Resource Name (ARN) of the certificate authority being used.

  • :client_token (String) —

    Idempotency token.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier of the Active Directory.

  • :tags (Hash<String,String>) —

    Metadata assigned to a connector consisting of a key-value pair.

  • :vpc_information (required, Types::VpcInformation) —

    Information about your VPC and security groups used with the connector.

Returns:

See Also:



530
531
532
533
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 530

def create_connector(params = {}, options = {})
  req = build_request(:create_connector, params)
  req.send_request(options)
end

#create_directory_registration(params = {}) ⇒ Types::CreateDirectoryRegistrationResponse

Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory

Examples:

Request syntax with placeholder values


resp = client.create_directory_registration({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.directory_registration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Idempotency token.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier of the Active Directory.

  • :tags (Hash<String,String>) —

    Metadata assigned to a directory registration consisting of a key-value pair.

Returns:

See Also:



573
574
575
576
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 573

def create_directory_registration(params = {}, options = {})
  req = build_request(:create_directory_registration, params)
  req.send_request(options)
end

#create_service_principal_name(params = {}) ⇒ Struct

Creates a service principal name (SPN) for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a service sign-in account.

Examples:

Request syntax with placeholder values


resp = client.create_service_principal_name({
  client_token: "ClientToken",
  connector_arn: "ConnectorArn", # required
  directory_registration_arn: "DirectoryRegistrationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



618
619
620
621
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 618

def create_service_principal_name(params = {}, options = {})
  req = build_request(:create_service_principal_name, params)
  req.send_request(options)
end

#create_template(params = {}) ⇒ Types::CreateTemplateResponse

Creates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.

Examples:

Request syntax with placeholder values


resp = client.create_template({
  client_token: "ClientToken",
  connector_arn: "ConnectorArn", # required
  definition: { # required
    template_v2: {
      certificate_validity: { # required
        renewal_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
        validity_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
      },
      enrollment_flags: { # required
        enable_key_reuse_on_nt_token_keyset_storage_full: false,
        include_symmetric_algorithms: false,
        no_security_extension: false,
        remove_invalid_certificate_from_personal_store: false,
        user_interaction_required: false,
      },
      extensions: { # required
        application_policies: {
          critical: false,
          policies: [ # required
            {
              policy_object_identifier: "CustomObjectIdentifier",
              policy_type: "ALL_APPLICATION_POLICIES", # accepts ALL_APPLICATION_POLICIES, ANY_PURPOSE, ATTESTATION_IDENTITY_KEY_CERTIFICATE, CERTIFICATE_REQUEST_AGENT, CLIENT_AUTHENTICATION, CODE_SIGNING, CTL_USAGE, DIGITAL_RIGHTS, DIRECTORY_SERVICE_EMAIL_REPLICATION, DISALLOWED_LIST, DNS_SERVER_TRUST, DOCUMENT_ENCRYPTION, DOCUMENT_SIGNING, DYNAMIC_CODE_GENERATOR, EARLY_LAUNCH_ANTIMALWARE_DRIVER, EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, ENCLAVE, ENCRYPTING_FILE_SYSTEM, ENDORSEMENT_KEY_CERTIFICATE, FILE_RECOVERY, HAL_EXTENSION, IP_SECURITY_END_SYSTEM, IP_SECURITY_IKE_INTERMEDIATE, IP_SECURITY_TUNNEL_TERMINATION, IP_SECURITY_USER, ISOLATED_USER_MODE, KDC_AUTHENTICATION, KERNEL_MODE_CODE_SIGNING, KEY_PACK_LICENSES, KEY_RECOVERY, KEY_RECOVERY_AGENT, LICENSE_SERVER_VERIFICATION, LIFETIME_SIGNING, MICROSOFT_PUBLISHER, MICROSOFT_TIME_STAMPING, MICROSOFT_TRUST_LIST_SIGNING, OCSP_SIGNING, OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, PLATFORM_CERTIFICATE, PREVIEW_BUILD_SIGNING, PRIVATE_KEY_ARCHIVAL, PROTECTED_PROCESS_LIGHT_VERIFICATION, PROTECTED_PROCESS_VERIFICATION, QUALIFIED_SUBORDINATION, REVOKED_LIST_SIGNER, ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION, ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION, ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL, ROOT_LIST_SIGNER, SECURE_EMAIL, SERVER_AUTHENTICATION, SMART_CARD_LOGIN, SPC_ENCRYPTED_DIGEST_RETRY_COUNT, SPC_RELAXED_PE_MARKER_CHECK, TIME_STAMPING, WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_VERIFICATION, WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION, WINDOWS_KITS_COMPONENT, WINDOWS_RT_VERIFICATION, WINDOWS_SOFTWARE_EXTENSION_VERIFICATION, WINDOWS_STORE, WINDOWS_SYSTEM_COMPONENT_VERIFICATION, WINDOWS_TCB_COMPONENT, WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT, WINDOWS_UPDATE
            },
          ],
        },
        key_usage: { # required
          critical: false,
          usage_flags: { # required
            data_encipherment: false,
            digital_signature: false,
            key_agreement: false,
            key_encipherment: false,
            non_repudiation: false,
          },
        },
      },
      general_flags: { # required
        auto_enrollment: false,
        machine_type: false,
      },
      private_key_attributes: { # required
        crypto_providers: ["CryptoProvidersListMemberString"],
        key_spec: "KEY_EXCHANGE", # required, accepts KEY_EXCHANGE, SIGNATURE
        minimal_key_length: 1, # required
      },
      private_key_flags: { # required
        client_version: "WINDOWS_SERVER_2003", # required, accepts WINDOWS_SERVER_2003, WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016
        exportable_key: false,
        strong_key_protection_required: false,
      },
      subject_name_flags: { # required
        require_common_name: false,
        require_directory_path: false,
        require_dns_as_cn: false,
        require_email: false,
        san_require_directory_guid: false,
        san_require_dns: false,
        san_require_domain_dns: false,
        san_require_email: false,
        san_require_spn: false,
        san_require_upn: false,
      },
      superseded_templates: ["TemplateName"],
    },
    template_v3: {
      certificate_validity: { # required
        renewal_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
        validity_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
      },
      enrollment_flags: { # required
        enable_key_reuse_on_nt_token_keyset_storage_full: false,
        include_symmetric_algorithms: false,
        no_security_extension: false,
        remove_invalid_certificate_from_personal_store: false,
        user_interaction_required: false,
      },
      extensions: { # required
        application_policies: {
          critical: false,
          policies: [ # required
            {
              policy_object_identifier: "CustomObjectIdentifier",
              policy_type: "ALL_APPLICATION_POLICIES", # accepts ALL_APPLICATION_POLICIES, ANY_PURPOSE, ATTESTATION_IDENTITY_KEY_CERTIFICATE, CERTIFICATE_REQUEST_AGENT, CLIENT_AUTHENTICATION, CODE_SIGNING, CTL_USAGE, DIGITAL_RIGHTS, DIRECTORY_SERVICE_EMAIL_REPLICATION, DISALLOWED_LIST, DNS_SERVER_TRUST, DOCUMENT_ENCRYPTION, DOCUMENT_SIGNING, DYNAMIC_CODE_GENERATOR, EARLY_LAUNCH_ANTIMALWARE_DRIVER, EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, ENCLAVE, ENCRYPTING_FILE_SYSTEM, ENDORSEMENT_KEY_CERTIFICATE, FILE_RECOVERY, HAL_EXTENSION, IP_SECURITY_END_SYSTEM, IP_SECURITY_IKE_INTERMEDIATE, IP_SECURITY_TUNNEL_TERMINATION, IP_SECURITY_USER, ISOLATED_USER_MODE, KDC_AUTHENTICATION, KERNEL_MODE_CODE_SIGNING, KEY_PACK_LICENSES, KEY_RECOVERY, KEY_RECOVERY_AGENT, LICENSE_SERVER_VERIFICATION, LIFETIME_SIGNING, MICROSOFT_PUBLISHER, MICROSOFT_TIME_STAMPING, MICROSOFT_TRUST_LIST_SIGNING, OCSP_SIGNING, OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, PLATFORM_CERTIFICATE, PREVIEW_BUILD_SIGNING, PRIVATE_KEY_ARCHIVAL, PROTECTED_PROCESS_LIGHT_VERIFICATION, PROTECTED_PROCESS_VERIFICATION, QUALIFIED_SUBORDINATION, REVOKED_LIST_SIGNER, ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION, ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION, ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL, ROOT_LIST_SIGNER, SECURE_EMAIL, SERVER_AUTHENTICATION, SMART_CARD_LOGIN, SPC_ENCRYPTED_DIGEST_RETRY_COUNT, SPC_RELAXED_PE_MARKER_CHECK, TIME_STAMPING, WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_VERIFICATION, WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION, WINDOWS_KITS_COMPONENT, WINDOWS_RT_VERIFICATION, WINDOWS_SOFTWARE_EXTENSION_VERIFICATION, WINDOWS_STORE, WINDOWS_SYSTEM_COMPONENT_VERIFICATION, WINDOWS_TCB_COMPONENT, WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT, WINDOWS_UPDATE
            },
          ],
        },
        key_usage: { # required
          critical: false,
          usage_flags: { # required
            data_encipherment: false,
            digital_signature: false,
            key_agreement: false,
            key_encipherment: false,
            non_repudiation: false,
          },
        },
      },
      general_flags: { # required
        auto_enrollment: false,
        machine_type: false,
      },
      hash_algorithm: "SHA256", # required, accepts SHA256, SHA384, SHA512
      private_key_attributes: { # required
        algorithm: "RSA", # required, accepts RSA, ECDH_P256, ECDH_P384, ECDH_P521
        crypto_providers: ["CryptoProvidersListMemberString"],
        key_spec: "KEY_EXCHANGE", # required, accepts KEY_EXCHANGE, SIGNATURE
        key_usage_property: { # required
          property_flags: {
            decrypt: false,
            key_agreement: false,
            sign: false,
          },
          property_type: "ALL", # accepts ALL
        },
        minimal_key_length: 1, # required
      },
      private_key_flags: { # required
        client_version: "WINDOWS_SERVER_2008", # required, accepts WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016
        exportable_key: false,
        require_alternate_signature_algorithm: false,
        strong_key_protection_required: false,
      },
      subject_name_flags: { # required
        require_common_name: false,
        require_directory_path: false,
        require_dns_as_cn: false,
        require_email: false,
        san_require_directory_guid: false,
        san_require_dns: false,
        san_require_domain_dns: false,
        san_require_email: false,
        san_require_spn: false,
        san_require_upn: false,
      },
      superseded_templates: ["TemplateName"],
    },
    template_v4: {
      certificate_validity: { # required
        renewal_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
        validity_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
      },
      enrollment_flags: { # required
        enable_key_reuse_on_nt_token_keyset_storage_full: false,
        include_symmetric_algorithms: false,
        no_security_extension: false,
        remove_invalid_certificate_from_personal_store: false,
        user_interaction_required: false,
      },
      extensions: { # required
        application_policies: {
          critical: false,
          policies: [ # required
            {
              policy_object_identifier: "CustomObjectIdentifier",
              policy_type: "ALL_APPLICATION_POLICIES", # accepts ALL_APPLICATION_POLICIES, ANY_PURPOSE, ATTESTATION_IDENTITY_KEY_CERTIFICATE, CERTIFICATE_REQUEST_AGENT, CLIENT_AUTHENTICATION, CODE_SIGNING, CTL_USAGE, DIGITAL_RIGHTS, DIRECTORY_SERVICE_EMAIL_REPLICATION, DISALLOWED_LIST, DNS_SERVER_TRUST, DOCUMENT_ENCRYPTION, DOCUMENT_SIGNING, DYNAMIC_CODE_GENERATOR, EARLY_LAUNCH_ANTIMALWARE_DRIVER, EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, ENCLAVE, ENCRYPTING_FILE_SYSTEM, ENDORSEMENT_KEY_CERTIFICATE, FILE_RECOVERY, HAL_EXTENSION, IP_SECURITY_END_SYSTEM, IP_SECURITY_IKE_INTERMEDIATE, IP_SECURITY_TUNNEL_TERMINATION, IP_SECURITY_USER, ISOLATED_USER_MODE, KDC_AUTHENTICATION, KERNEL_MODE_CODE_SIGNING, KEY_PACK_LICENSES, KEY_RECOVERY, KEY_RECOVERY_AGENT, LICENSE_SERVER_VERIFICATION, LIFETIME_SIGNING, MICROSOFT_PUBLISHER, MICROSOFT_TIME_STAMPING, MICROSOFT_TRUST_LIST_SIGNING, OCSP_SIGNING, OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, PLATFORM_CERTIFICATE, PREVIEW_BUILD_SIGNING, PRIVATE_KEY_ARCHIVAL, PROTECTED_PROCESS_LIGHT_VERIFICATION, PROTECTED_PROCESS_VERIFICATION, QUALIFIED_SUBORDINATION, REVOKED_LIST_SIGNER, ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION, ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION, ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL, ROOT_LIST_SIGNER, SECURE_EMAIL, SERVER_AUTHENTICATION, SMART_CARD_LOGIN, SPC_ENCRYPTED_DIGEST_RETRY_COUNT, SPC_RELAXED_PE_MARKER_CHECK, TIME_STAMPING, WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_VERIFICATION, WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION, WINDOWS_KITS_COMPONENT, WINDOWS_RT_VERIFICATION, WINDOWS_SOFTWARE_EXTENSION_VERIFICATION, WINDOWS_STORE, WINDOWS_SYSTEM_COMPONENT_VERIFICATION, WINDOWS_TCB_COMPONENT, WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT, WINDOWS_UPDATE
            },
          ],
        },
        key_usage: { # required
          critical: false,
          usage_flags: { # required
            data_encipherment: false,
            digital_signature: false,
            key_agreement: false,
            key_encipherment: false,
            non_repudiation: false,
          },
        },
      },
      general_flags: { # required
        auto_enrollment: false,
        machine_type: false,
      },
      hash_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512
      private_key_attributes: { # required
        algorithm: "RSA", # accepts RSA, ECDH_P256, ECDH_P384, ECDH_P521
        crypto_providers: ["CryptoProvidersListMemberString"],
        key_spec: "KEY_EXCHANGE", # required, accepts KEY_EXCHANGE, SIGNATURE
        key_usage_property: {
          property_flags: {
            decrypt: false,
            key_agreement: false,
            sign: false,
          },
          property_type: "ALL", # accepts ALL
        },
        minimal_key_length: 1, # required
      },
      private_key_flags: { # required
        client_version: "WINDOWS_SERVER_2012", # required, accepts WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016
        exportable_key: false,
        require_alternate_signature_algorithm: false,
        require_same_key_renewal: false,
        strong_key_protection_required: false,
        use_legacy_provider: false,
      },
      subject_name_flags: { # required
        require_common_name: false,
        require_directory_path: false,
        require_dns_as_cn: false,
        require_email: false,
        san_require_directory_guid: false,
        san_require_dns: false,
        san_require_domain_dns: false,
        san_require_email: false,
        san_require_spn: false,
        san_require_upn: false,
      },
      superseded_templates: ["TemplateName"],
    },
  },
  name: "TemplateName", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.template_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Idempotency token.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you called [CreateConnector].

    [1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html

  • :definition (required, Types::TemplateDefinition) —

    Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

  • :name (required, String) —

    Name of the template. The template name must be unique.

  • :tags (Hash<String,String>) —

    Metadata assigned to a template consisting of a key-value pair.

Returns:

See Also:



903
904
905
906
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 903

def create_template(params = {}, options = {})
  req = build_request(:create_template, params)
  req.send_request(options)
end

#create_template_group_access_control_entry(params = {}) ⇒ Struct

Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers (SIDs).

Examples:

Request syntax with placeholder values


resp = client.create_template_group_access_control_entry({
  access_rights: { # required
    auto_enroll: "ALLOW", # accepts ALLOW, DENY
    enroll: "ALLOW", # accepts ALLOW, DENY
  },
  client_token: "ClientToken",
  group_display_name: "DisplayName", # required
  group_security_identifier: "GroupSecurityIdentifier", # required
  template_arn: "TemplateArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_rights (required, Types::AccessRights) —

    Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template.

  • :client_token (String) —

    Idempotency token.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :group_display_name (required, String) —

    Name of the Active Directory group. This name does not need to match the group name in Active Directory.

  • :group_security_identifier (required, String) —

    Security identifier (SID) of the group object from Active Directory. The SID starts with “S-”.

  • :template_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate].

    [1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



957
958
959
960
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 957

def create_template_group_access_control_entry(params = {}, options = {})
  req = build_request(:create_template_group_access_control_entry, params)
  req.send_request(options)
end

#delete_connector(params = {}) ⇒ Struct

Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the

docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors][1

action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the

docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration][2

action.

[1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors [2]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration

Examples:

Request syntax with placeholder values


resp = client.delete_connector({
  connector_arn: "ConnectorArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



997
998
999
1000
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 997

def delete_connector(params = {}, options = {})
  req = build_request(:delete_connector, params)
  req.send_request(options)
end

#delete_directory_registration(params = {}) ⇒ Struct

Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.

Examples:

Request syntax with placeholder values


resp = client.delete_directory_registration({
  directory_registration_arn: "DirectoryRegistrationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1025
1026
1027
1028
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1025

def delete_directory_registration(params = {}, options = {})
  req = build_request(:delete_directory_registration, params)
  req.send_request(options)
end

#delete_service_principal_name(params = {}) ⇒ Struct

Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.

Examples:

Request syntax with placeholder values


resp = client.delete_service_principal_name({
  connector_arn: "ConnectorArn", # required
  directory_registration_arn: "DirectoryRegistrationArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1062
1063
1064
1065
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1062

def delete_service_principal_name(params = {}, options = {})
  req = build_request(:delete_service_principal_name, params)
  req.send_request(options)
end

#delete_template(params = {}) ⇒ Struct

Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.

Examples:

Request syntax with placeholder values


resp = client.delete_template({
  template_arn: "TemplateArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1090
1091
1092
1093
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1090

def delete_template(params = {}, options = {})
  req = build_request(:delete_template, params)
  req.send_request(options)
end

#delete_template_group_access_control_entry(params = {}) ⇒ Struct

Deletes a group access control entry.

Examples:

Request syntax with placeholder values


resp = client.delete_template_group_access_control_entry({
  group_security_identifier: "GroupSecurityIdentifier", # required
  template_arn: "TemplateArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1122
1123
1124
1125
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1122

def delete_template_group_access_control_entry(params = {}, options = {})
  req = build_request(:delete_template_group_access_control_entry, params)
  req.send_request(options)
end

#get_connector(params = {}) ⇒ Types::GetConnectorResponse

Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).

Examples:

Request syntax with placeholder values


resp = client.get_connector({
  connector_arn: "ConnectorArn", # required
})

Response structure


resp.connector.arn #=> String
resp.connector.certificate_authority_arn #=> String
resp.connector.certificate_enrollment_policy_server_endpoint #=> String
resp.connector.created_at #=> Time
resp.connector.directory_id #=> String
resp.connector.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.connector.status_reason #=> String, one of "CA_CERTIFICATE_REGISTRATION_FAILED", "DIRECTORY_ACCESS_DENIED", "INTERNAL_FAILURE", "INSUFFICIENT_FREE_ADDRESSES", "INVALID_SUBNET_IP_PROTOCOL", "PRIVATECA_ACCESS_DENIED", "PRIVATECA_RESOURCE_NOT_FOUND", "SECURITY_GROUP_NOT_IN_VPC", "VPC_ACCESS_DENIED", "VPC_ENDPOINT_LIMIT_EXCEEDED", "VPC_RESOURCE_NOT_FOUND"
resp.connector.updated_at #=> Time
resp.connector.vpc_information.ip_address_type #=> String, one of "IPV4", "DUALSTACK"
resp.connector.vpc_information.security_group_ids #=> Array
resp.connector.vpc_information.security_group_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1166
1167
1168
1169
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1166

def get_connector(params = {}, options = {})
  req = build_request(:get_connector, params)
  req.send_request(options)
end

#get_directory_registration(params = {}) ⇒ Types::GetDirectoryRegistrationResponse

A structure that contains information about your directory registration.

Examples:

Request syntax with placeholder values


resp = client.get_directory_registration({
  directory_registration_arn: "DirectoryRegistrationArn", # required
})

Response structure


resp.directory_registration.arn #=> String
resp.directory_registration.created_at #=> Time
resp.directory_registration.directory_id #=> String
resp.directory_registration.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.directory_registration.status_reason #=> String, one of "DIRECTORY_ACCESS_DENIED", "DIRECTORY_RESOURCE_NOT_FOUND", "DIRECTORY_NOT_ACTIVE", "DIRECTORY_NOT_REACHABLE", "DIRECTORY_TYPE_NOT_SUPPORTED", "INTERNAL_FAILURE"
resp.directory_registration.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1205
1206
1207
1208
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1205

def get_directory_registration(params = {}, options = {})
  req = build_request(:get_directory_registration, params)
  req.send_request(options)
end

#get_service_principal_name(params = {}) ⇒ Types::GetServicePrincipalNameResponse

Lists the service principal name that the connector uses to authenticate with Active Directory.

Examples:

Request syntax with placeholder values


resp = client.get_service_principal_name({
  connector_arn: "ConnectorArn", # required
  directory_registration_arn: "DirectoryRegistrationArn", # required
})

Response structure


resp.service_principal_name.connector_arn #=> String
resp.service_principal_name.created_at #=> Time
resp.service_principal_name.directory_registration_arn #=> String
resp.service_principal_name.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.service_principal_name.status_reason #=> String, one of "DIRECTORY_ACCESS_DENIED", "DIRECTORY_NOT_REACHABLE", "DIRECTORY_RESOURCE_NOT_FOUND", "SPN_EXISTS_ON_DIFFERENT_AD_OBJECT", "SPN_LIMIT_EXCEEDED", "INTERNAL_FAILURE"
resp.service_principal_name.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1253
1254
1255
1256
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1253

def get_service_principal_name(params = {}, options = {})
  req = build_request(:get_service_principal_name, params)
  req.send_request(options)
end

#get_template(params = {}) ⇒ Types::GetTemplateResponse

Retrieves a certificate template that the connector uses to issue certificates from a private CA.

Examples:

Request syntax with placeholder values


resp = client.get_template({
  template_arn: "TemplateArn", # required
})

Response structure


resp.template.arn #=> String
resp.template.connector_arn #=> String
resp.template.created_at #=> Time
resp.template.definition.template_v2.certificate_validity.renewal_period.period #=> Integer
resp.template.definition.template_v2.certificate_validity.renewal_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.template.definition.template_v2.certificate_validity.validity_period.period #=> Integer
resp.template.definition.template_v2.certificate_validity.validity_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.template.definition.template_v2.enrollment_flags.enable_key_reuse_on_nt_token_keyset_storage_full #=> Boolean
resp.template.definition.template_v2.enrollment_flags.include_symmetric_algorithms #=> Boolean
resp.template.definition.template_v2.enrollment_flags.no_security_extension #=> Boolean
resp.template.definition.template_v2.enrollment_flags.remove_invalid_certificate_from_personal_store #=> Boolean
resp.template.definition.template_v2.enrollment_flags.user_interaction_required #=> Boolean
resp.template.definition.template_v2.extensions.application_policies.critical #=> Boolean
resp.template.definition.template_v2.extensions.application_policies.policies #=> Array
resp.template.definition.template_v2.extensions.application_policies.policies[0].policy_object_identifier #=> String
resp.template.definition.template_v2.extensions.application_policies.policies[0].policy_type #=> String, one of "ALL_APPLICATION_POLICIES", "ANY_PURPOSE", "ATTESTATION_IDENTITY_KEY_CERTIFICATE", "CERTIFICATE_REQUEST_AGENT", "CLIENT_AUTHENTICATION", "CODE_SIGNING", "CTL_USAGE", "DIGITAL_RIGHTS", "DIRECTORY_SERVICE_EMAIL_REPLICATION", "DISALLOWED_LIST", "DNS_SERVER_TRUST", "DOCUMENT_ENCRYPTION", "DOCUMENT_SIGNING", "DYNAMIC_CODE_GENERATOR", "EARLY_LAUNCH_ANTIMALWARE_DRIVER", "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "ENCLAVE", "ENCRYPTING_FILE_SYSTEM", "ENDORSEMENT_KEY_CERTIFICATE", "FILE_RECOVERY", "HAL_EXTENSION", "IP_SECURITY_END_SYSTEM", "IP_SECURITY_IKE_INTERMEDIATE", "IP_SECURITY_TUNNEL_TERMINATION", "IP_SECURITY_USER", "ISOLATED_USER_MODE", "KDC_AUTHENTICATION", "KERNEL_MODE_CODE_SIGNING", "KEY_PACK_LICENSES", "KEY_RECOVERY", "KEY_RECOVERY_AGENT", "LICENSE_SERVER_VERIFICATION", "LIFETIME_SIGNING", "MICROSOFT_PUBLISHER", "MICROSOFT_TIME_STAMPING", "MICROSOFT_TRUST_LIST_SIGNING", "OCSP_SIGNING", "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "PLATFORM_CERTIFICATE", "PREVIEW_BUILD_SIGNING", "PRIVATE_KEY_ARCHIVAL", "PROTECTED_PROCESS_LIGHT_VERIFICATION", "PROTECTED_PROCESS_VERIFICATION", "QUALIFIED_SUBORDINATION", "REVOKED_LIST_SIGNER", "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", "ROOT_LIST_SIGNER", "SECURE_EMAIL", "SERVER_AUTHENTICATION", "SMART_CARD_LOGIN", "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", "SPC_RELAXED_PE_MARKER_CHECK", "TIME_STAMPING", "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_VERIFICATION", "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", "WINDOWS_KITS_COMPONENT", "WINDOWS_RT_VERIFICATION", "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", "WINDOWS_STORE", "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "WINDOWS_TCB_COMPONENT", "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", "WINDOWS_UPDATE"
resp.template.definition.template_v2.extensions.key_usage.critical #=> Boolean
resp.template.definition.template_v2.extensions.key_usage.usage_flags.data_encipherment #=> Boolean
resp.template.definition.template_v2.extensions.key_usage.usage_flags.digital_signature #=> Boolean
resp.template.definition.template_v2.extensions.key_usage.usage_flags.key_agreement #=> Boolean
resp.template.definition.template_v2.extensions.key_usage.usage_flags.key_encipherment #=> Boolean
resp.template.definition.template_v2.extensions.key_usage.usage_flags.non_repudiation #=> Boolean
resp.template.definition.template_v2.general_flags.auto_enrollment #=> Boolean
resp.template.definition.template_v2.general_flags.machine_type #=> Boolean
resp.template.definition.template_v2.private_key_attributes.crypto_providers #=> Array
resp.template.definition.template_v2.private_key_attributes.crypto_providers[0] #=> String
resp.template.definition.template_v2.private_key_attributes.key_spec #=> String, one of "KEY_EXCHANGE", "SIGNATURE"
resp.template.definition.template_v2.private_key_attributes.minimal_key_length #=> Integer
resp.template.definition.template_v2.private_key_flags.client_version #=> String, one of "WINDOWS_SERVER_2003", "WINDOWS_SERVER_2008", "WINDOWS_SERVER_2008_R2", "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016"
resp.template.definition.template_v2.private_key_flags.exportable_key #=> Boolean
resp.template.definition.template_v2.private_key_flags.strong_key_protection_required #=> Boolean
resp.template.definition.template_v2.subject_name_flags.require_common_name #=> Boolean
resp.template.definition.template_v2.subject_name_flags.require_directory_path #=> Boolean
resp.template.definition.template_v2.subject_name_flags.require_dns_as_cn #=> Boolean
resp.template.definition.template_v2.subject_name_flags.require_email #=> Boolean
resp.template.definition.template_v2.subject_name_flags.san_require_directory_guid #=> Boolean
resp.template.definition.template_v2.subject_name_flags.san_require_dns #=> Boolean
resp.template.definition.template_v2.subject_name_flags.san_require_domain_dns #=> Boolean
resp.template.definition.template_v2.subject_name_flags.san_require_email #=> Boolean
resp.template.definition.template_v2.subject_name_flags.san_require_spn #=> Boolean
resp.template.definition.template_v2.subject_name_flags.san_require_upn #=> Boolean
resp.template.definition.template_v2.superseded_templates #=> Array
resp.template.definition.template_v2.superseded_templates[0] #=> String
resp.template.definition.template_v3.certificate_validity.renewal_period.period #=> Integer
resp.template.definition.template_v3.certificate_validity.renewal_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.template.definition.template_v3.certificate_validity.validity_period.period #=> Integer
resp.template.definition.template_v3.certificate_validity.validity_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.template.definition.template_v3.enrollment_flags.enable_key_reuse_on_nt_token_keyset_storage_full #=> Boolean
resp.template.definition.template_v3.enrollment_flags.include_symmetric_algorithms #=> Boolean
resp.template.definition.template_v3.enrollment_flags.no_security_extension #=> Boolean
resp.template.definition.template_v3.enrollment_flags.remove_invalid_certificate_from_personal_store #=> Boolean
resp.template.definition.template_v3.enrollment_flags.user_interaction_required #=> Boolean
resp.template.definition.template_v3.extensions.application_policies.critical #=> Boolean
resp.template.definition.template_v3.extensions.application_policies.policies #=> Array
resp.template.definition.template_v3.extensions.application_policies.policies[0].policy_object_identifier #=> String
resp.template.definition.template_v3.extensions.application_policies.policies[0].policy_type #=> String, one of "ALL_APPLICATION_POLICIES", "ANY_PURPOSE", "ATTESTATION_IDENTITY_KEY_CERTIFICATE", "CERTIFICATE_REQUEST_AGENT", "CLIENT_AUTHENTICATION", "CODE_SIGNING", "CTL_USAGE", "DIGITAL_RIGHTS", "DIRECTORY_SERVICE_EMAIL_REPLICATION", "DISALLOWED_LIST", "DNS_SERVER_TRUST", "DOCUMENT_ENCRYPTION", "DOCUMENT_SIGNING", "DYNAMIC_CODE_GENERATOR", "EARLY_LAUNCH_ANTIMALWARE_DRIVER", "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "ENCLAVE", "ENCRYPTING_FILE_SYSTEM", "ENDORSEMENT_KEY_CERTIFICATE", "FILE_RECOVERY", "HAL_EXTENSION", "IP_SECURITY_END_SYSTEM", "IP_SECURITY_IKE_INTERMEDIATE", "IP_SECURITY_TUNNEL_TERMINATION", "IP_SECURITY_USER", "ISOLATED_USER_MODE", "KDC_AUTHENTICATION", "KERNEL_MODE_CODE_SIGNING", "KEY_PACK_LICENSES", "KEY_RECOVERY", "KEY_RECOVERY_AGENT", "LICENSE_SERVER_VERIFICATION", "LIFETIME_SIGNING", "MICROSOFT_PUBLISHER", "MICROSOFT_TIME_STAMPING", "MICROSOFT_TRUST_LIST_SIGNING", "OCSP_SIGNING", "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "PLATFORM_CERTIFICATE", "PREVIEW_BUILD_SIGNING", "PRIVATE_KEY_ARCHIVAL", "PROTECTED_PROCESS_LIGHT_VERIFICATION", "PROTECTED_PROCESS_VERIFICATION", "QUALIFIED_SUBORDINATION", "REVOKED_LIST_SIGNER", "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", "ROOT_LIST_SIGNER", "SECURE_EMAIL", "SERVER_AUTHENTICATION", "SMART_CARD_LOGIN", "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", "SPC_RELAXED_PE_MARKER_CHECK", "TIME_STAMPING", "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_VERIFICATION", "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", "WINDOWS_KITS_COMPONENT", "WINDOWS_RT_VERIFICATION", "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", "WINDOWS_STORE", "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "WINDOWS_TCB_COMPONENT", "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", "WINDOWS_UPDATE"
resp.template.definition.template_v3.extensions.key_usage.critical #=> Boolean
resp.template.definition.template_v3.extensions.key_usage.usage_flags.data_encipherment #=> Boolean
resp.template.definition.template_v3.extensions.key_usage.usage_flags.digital_signature #=> Boolean
resp.template.definition.template_v3.extensions.key_usage.usage_flags.key_agreement #=> Boolean
resp.template.definition.template_v3.extensions.key_usage.usage_flags.key_encipherment #=> Boolean
resp.template.definition.template_v3.extensions.key_usage.usage_flags.non_repudiation #=> Boolean
resp.template.definition.template_v3.general_flags.auto_enrollment #=> Boolean
resp.template.definition.template_v3.general_flags.machine_type #=> Boolean
resp.template.definition.template_v3.hash_algorithm #=> String, one of "SHA256", "SHA384", "SHA512"
resp.template.definition.template_v3.private_key_attributes.algorithm #=> String, one of "RSA", "ECDH_P256", "ECDH_P384", "ECDH_P521"
resp.template.definition.template_v3.private_key_attributes.crypto_providers #=> Array
resp.template.definition.template_v3.private_key_attributes.crypto_providers[0] #=> String
resp.template.definition.template_v3.private_key_attributes.key_spec #=> String, one of "KEY_EXCHANGE", "SIGNATURE"
resp.template.definition.template_v3.private_key_attributes.key_usage_property.property_flags.decrypt #=> Boolean
resp.template.definition.template_v3.private_key_attributes.key_usage_property.property_flags.key_agreement #=> Boolean
resp.template.definition.template_v3.private_key_attributes.key_usage_property.property_flags.sign #=> Boolean
resp.template.definition.template_v3.private_key_attributes.key_usage_property.property_type #=> String, one of "ALL"
resp.template.definition.template_v3.private_key_attributes.minimal_key_length #=> Integer
resp.template.definition.template_v3.private_key_flags.client_version #=> String, one of "WINDOWS_SERVER_2008", "WINDOWS_SERVER_2008_R2", "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016"
resp.template.definition.template_v3.private_key_flags.exportable_key #=> Boolean
resp.template.definition.template_v3.private_key_flags.require_alternate_signature_algorithm #=> Boolean
resp.template.definition.template_v3.private_key_flags.strong_key_protection_required #=> Boolean
resp.template.definition.template_v3.subject_name_flags.require_common_name #=> Boolean
resp.template.definition.template_v3.subject_name_flags.require_directory_path #=> Boolean
resp.template.definition.template_v3.subject_name_flags.require_dns_as_cn #=> Boolean
resp.template.definition.template_v3.subject_name_flags.require_email #=> Boolean
resp.template.definition.template_v3.subject_name_flags.san_require_directory_guid #=> Boolean
resp.template.definition.template_v3.subject_name_flags.san_require_dns #=> Boolean
resp.template.definition.template_v3.subject_name_flags.san_require_domain_dns #=> Boolean
resp.template.definition.template_v3.subject_name_flags.san_require_email #=> Boolean
resp.template.definition.template_v3.subject_name_flags.san_require_spn #=> Boolean
resp.template.definition.template_v3.subject_name_flags.san_require_upn #=> Boolean
resp.template.definition.template_v3.superseded_templates #=> Array
resp.template.definition.template_v3.superseded_templates[0] #=> String
resp.template.definition.template_v4.certificate_validity.renewal_period.period #=> Integer
resp.template.definition.template_v4.certificate_validity.renewal_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.template.definition.template_v4.certificate_validity.validity_period.period #=> Integer
resp.template.definition.template_v4.certificate_validity.validity_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.template.definition.template_v4.enrollment_flags.enable_key_reuse_on_nt_token_keyset_storage_full #=> Boolean
resp.template.definition.template_v4.enrollment_flags.include_symmetric_algorithms #=> Boolean
resp.template.definition.template_v4.enrollment_flags.no_security_extension #=> Boolean
resp.template.definition.template_v4.enrollment_flags.remove_invalid_certificate_from_personal_store #=> Boolean
resp.template.definition.template_v4.enrollment_flags.user_interaction_required #=> Boolean
resp.template.definition.template_v4.extensions.application_policies.critical #=> Boolean
resp.template.definition.template_v4.extensions.application_policies.policies #=> Array
resp.template.definition.template_v4.extensions.application_policies.policies[0].policy_object_identifier #=> String
resp.template.definition.template_v4.extensions.application_policies.policies[0].policy_type #=> String, one of "ALL_APPLICATION_POLICIES", "ANY_PURPOSE", "ATTESTATION_IDENTITY_KEY_CERTIFICATE", "CERTIFICATE_REQUEST_AGENT", "CLIENT_AUTHENTICATION", "CODE_SIGNING", "CTL_USAGE", "DIGITAL_RIGHTS", "DIRECTORY_SERVICE_EMAIL_REPLICATION", "DISALLOWED_LIST", "DNS_SERVER_TRUST", "DOCUMENT_ENCRYPTION", "DOCUMENT_SIGNING", "DYNAMIC_CODE_GENERATOR", "EARLY_LAUNCH_ANTIMALWARE_DRIVER", "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "ENCLAVE", "ENCRYPTING_FILE_SYSTEM", "ENDORSEMENT_KEY_CERTIFICATE", "FILE_RECOVERY", "HAL_EXTENSION", "IP_SECURITY_END_SYSTEM", "IP_SECURITY_IKE_INTERMEDIATE", "IP_SECURITY_TUNNEL_TERMINATION", "IP_SECURITY_USER", "ISOLATED_USER_MODE", "KDC_AUTHENTICATION", "KERNEL_MODE_CODE_SIGNING", "KEY_PACK_LICENSES", "KEY_RECOVERY", "KEY_RECOVERY_AGENT", "LICENSE_SERVER_VERIFICATION", "LIFETIME_SIGNING", "MICROSOFT_PUBLISHER", "MICROSOFT_TIME_STAMPING", "MICROSOFT_TRUST_LIST_SIGNING", "OCSP_SIGNING", "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "PLATFORM_CERTIFICATE", "PREVIEW_BUILD_SIGNING", "PRIVATE_KEY_ARCHIVAL", "PROTECTED_PROCESS_LIGHT_VERIFICATION", "PROTECTED_PROCESS_VERIFICATION", "QUALIFIED_SUBORDINATION", "REVOKED_LIST_SIGNER", "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", "ROOT_LIST_SIGNER", "SECURE_EMAIL", "SERVER_AUTHENTICATION", "SMART_CARD_LOGIN", "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", "SPC_RELAXED_PE_MARKER_CHECK", "TIME_STAMPING", "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_VERIFICATION", "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", "WINDOWS_KITS_COMPONENT", "WINDOWS_RT_VERIFICATION", "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", "WINDOWS_STORE", "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "WINDOWS_TCB_COMPONENT", "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", "WINDOWS_UPDATE"
resp.template.definition.template_v4.extensions.key_usage.critical #=> Boolean
resp.template.definition.template_v4.extensions.key_usage.usage_flags.data_encipherment #=> Boolean
resp.template.definition.template_v4.extensions.key_usage.usage_flags.digital_signature #=> Boolean
resp.template.definition.template_v4.extensions.key_usage.usage_flags.key_agreement #=> Boolean
resp.template.definition.template_v4.extensions.key_usage.usage_flags.key_encipherment #=> Boolean
resp.template.definition.template_v4.extensions.key_usage.usage_flags.non_repudiation #=> Boolean
resp.template.definition.template_v4.general_flags.auto_enrollment #=> Boolean
resp.template.definition.template_v4.general_flags.machine_type #=> Boolean
resp.template.definition.template_v4.hash_algorithm #=> String, one of "SHA256", "SHA384", "SHA512"
resp.template.definition.template_v4.private_key_attributes.algorithm #=> String, one of "RSA", "ECDH_P256", "ECDH_P384", "ECDH_P521"
resp.template.definition.template_v4.private_key_attributes.crypto_providers #=> Array
resp.template.definition.template_v4.private_key_attributes.crypto_providers[0] #=> String
resp.template.definition.template_v4.private_key_attributes.key_spec #=> String, one of "KEY_EXCHANGE", "SIGNATURE"
resp.template.definition.template_v4.private_key_attributes.key_usage_property.property_flags.decrypt #=> Boolean
resp.template.definition.template_v4.private_key_attributes.key_usage_property.property_flags.key_agreement #=> Boolean
resp.template.definition.template_v4.private_key_attributes.key_usage_property.property_flags.sign #=> Boolean
resp.template.definition.template_v4.private_key_attributes.key_usage_property.property_type #=> String, one of "ALL"
resp.template.definition.template_v4.private_key_attributes.minimal_key_length #=> Integer
resp.template.definition.template_v4.private_key_flags.client_version #=> String, one of "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016"
resp.template.definition.template_v4.private_key_flags.exportable_key #=> Boolean
resp.template.definition.template_v4.private_key_flags.require_alternate_signature_algorithm #=> Boolean
resp.template.definition.template_v4.private_key_flags.require_same_key_renewal #=> Boolean
resp.template.definition.template_v4.private_key_flags.strong_key_protection_required #=> Boolean
resp.template.definition.template_v4.private_key_flags.use_legacy_provider #=> Boolean
resp.template.definition.template_v4.subject_name_flags.require_common_name #=> Boolean
resp.template.definition.template_v4.subject_name_flags.require_directory_path #=> Boolean
resp.template.definition.template_v4.subject_name_flags.require_dns_as_cn #=> Boolean
resp.template.definition.template_v4.subject_name_flags.require_email #=> Boolean
resp.template.definition.template_v4.subject_name_flags.san_require_directory_guid #=> Boolean
resp.template.definition.template_v4.subject_name_flags.san_require_dns #=> Boolean
resp.template.definition.template_v4.subject_name_flags.san_require_domain_dns #=> Boolean
resp.template.definition.template_v4.subject_name_flags.san_require_email #=> Boolean
resp.template.definition.template_v4.subject_name_flags.san_require_spn #=> Boolean
resp.template.definition.template_v4.subject_name_flags.san_require_upn #=> Boolean
resp.template.definition.template_v4.superseded_templates #=> Array
resp.template.definition.template_v4.superseded_templates[0] #=> String
resp.template.name #=> String
resp.template.object_identifier #=> String
resp.template.policy_schema #=> Integer
resp.template.revision.major_revision #=> Integer
resp.template.revision.minor_revision #=> Integer
resp.template.status #=> String, one of "ACTIVE", "DELETING"
resp.template.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1432
1433
1434
1435
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1432

def get_template(params = {}, options = {})
  req = build_request(:get_template, params)
  req.send_request(options)
end

#get_template_group_access_control_entry(params = {}) ⇒ Types::GetTemplateGroupAccessControlEntryResponse

Retrieves the group access control entries for a template.

Examples:

Request syntax with placeholder values


resp = client.get_template_group_access_control_entry({
  group_security_identifier: "GroupSecurityIdentifier", # required
  template_arn: "TemplateArn", # required
})

Response structure


resp.access_control_entry.access_rights.auto_enroll #=> String, one of "ALLOW", "DENY"
resp.access_control_entry.access_rights.enroll #=> String, one of "ALLOW", "DENY"
resp.access_control_entry.created_at #=> Time
resp.access_control_entry.group_display_name #=> String
resp.access_control_entry.group_security_identifier #=> String
resp.access_control_entry.template_arn #=> String
resp.access_control_entry.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1476
1477
1478
1479
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1476

def get_template_group_access_control_entry(params = {}, options = {})
  req = build_request(:get_template_group_access_control_entry, params)
  req.send_request(options)
end

#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse

Lists the connectors that you created by using the

docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector][1

action.

[1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_connectors({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connectors #=> Array
resp.connectors[0].arn #=> String
resp.connectors[0].certificate_authority_arn #=> String
resp.connectors[0].certificate_enrollment_policy_server_endpoint #=> String
resp.connectors[0].created_at #=> Time
resp.connectors[0].directory_id #=> String
resp.connectors[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.connectors[0].status_reason #=> String, one of "CA_CERTIFICATE_REGISTRATION_FAILED", "DIRECTORY_ACCESS_DENIED", "INTERNAL_FAILURE", "INSUFFICIENT_FREE_ADDRESSES", "INVALID_SUBNET_IP_PROTOCOL", "PRIVATECA_ACCESS_DENIED", "PRIVATECA_RESOURCE_NOT_FOUND", "SECURITY_GROUP_NOT_IN_VPC", "VPC_ACCESS_DENIED", "VPC_ENDPOINT_LIMIT_EXCEEDED", "VPC_RESOURCE_NOT_FOUND"
resp.connectors[0].updated_at #=> Time
resp.connectors[0].vpc_information.ip_address_type #=> String, one of "IPV4", "DUALSTACK"
resp.connectors[0].vpc_information.security_group_ids #=> Array
resp.connectors[0].vpc_information.security_group_ids[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the ‘NextToken` element is sent in the response. Use this `NextToken` value in a subsequent request to retrieve additional items.

  • :next_token (String) —

    Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the ‘NextToken` parameter from the response you just received.

Returns:

See Also:



1536
1537
1538
1539
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1536

def list_connectors(params = {}, options = {})
  req = build_request(:list_connectors, params)
  req.send_request(options)
end

#list_directory_registrations(params = {}) ⇒ Types::ListDirectoryRegistrationsResponse

Lists the directory registrations that you created by using the

docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration][1

action.

[1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_directory_registrations({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.directory_registrations #=> Array
resp.directory_registrations[0].arn #=> String
resp.directory_registrations[0].created_at #=> Time
resp.directory_registrations[0].directory_id #=> String
resp.directory_registrations[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.directory_registrations[0].status_reason #=> String, one of "DIRECTORY_ACCESS_DENIED", "DIRECTORY_RESOURCE_NOT_FOUND", "DIRECTORY_NOT_ACTIVE", "DIRECTORY_NOT_REACHABLE", "DIRECTORY_TYPE_NOT_SUPPORTED", "INTERNAL_FAILURE"
resp.directory_registrations[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the ‘NextToken` element is sent in the response. Use this `NextToken` value in a subsequent request to retrieve additional items.

  • :next_token (String) —

    Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the ‘NextToken` parameter from the response you just received.

Returns:

See Also:



1591
1592
1593
1594
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1591

def list_directory_registrations(params = {}, options = {})
  req = build_request(:list_directory_registrations, params)
  req.send_request(options)
end

#list_service_principal_names(params = {}) ⇒ Types::ListServicePrincipalNamesResponse

Lists the service principal names that the connector uses to authenticate with Active Directory.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_service_principal_names({
  directory_registration_arn: "DirectoryRegistrationArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.service_principal_names #=> Array
resp.service_principal_names[0].connector_arn #=> String
resp.service_principal_names[0].created_at #=> Time
resp.service_principal_names[0].directory_registration_arn #=> String
resp.service_principal_names[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
resp.service_principal_names[0].status_reason #=> String, one of "DIRECTORY_ACCESS_DENIED", "DIRECTORY_NOT_REACHABLE", "DIRECTORY_RESOURCE_NOT_FOUND", "SPN_EXISTS_ON_DIFFERENT_AD_OBJECT", "SPN_LIMIT_EXCEEDED", "INTERNAL_FAILURE"
resp.service_principal_names[0].updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_registration_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration].

    [1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html

  • :max_results (Integer) —

    Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the ‘NextToken` element is sent in the response. Use this `NextToken` value in a subsequent request to retrieve additional items.

  • :next_token (String) —

    Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the ‘NextToken` parameter from the response you just received.

Returns:

See Also:



1650
1651
1652
1653
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1650

def list_service_principal_names(params = {}, options = {})
  req = build_request(:list_service_principal_names, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags, if any, that are associated with your resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you created the resource.

Returns:

See Also:



1680
1681
1682
1683
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1680

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_template_group_access_control_entries(params = {}) ⇒ Types::ListTemplateGroupAccessControlEntriesResponse

Lists group access control entries you created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_template_group_access_control_entries({
  max_results: 1,
  next_token: "NextToken",
  template_arn: "TemplateArn", # required
})

Response structure


resp.access_control_entries #=> Array
resp.access_control_entries[0].access_rights.auto_enroll #=> String, one of "ALLOW", "DENY"
resp.access_control_entries[0].access_rights.enroll #=> String, one of "ALLOW", "DENY"
resp.access_control_entries[0].created_at #=> Time
resp.access_control_entries[0].group_display_name #=> String
resp.access_control_entries[0].group_security_identifier #=> String
resp.access_control_entries[0].template_arn #=> String
resp.access_control_entries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the ‘NextToken` element is sent in the response. Use this `NextToken` value in a subsequent request to retrieve additional items.

  • :next_token (String) —

    Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the ‘NextToken` parameter from the response you just received.

  • :template_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate].

    [1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html

Returns:

See Also:



1739
1740
1741
1742
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1739

def list_template_group_access_control_entries(params = {}, options = {})
  req = build_request(:list_template_group_access_control_entries, params)
  req.send_request(options)
end

#list_templates(params = {}) ⇒ Types::ListTemplatesResponse

Lists the templates, if any, that are associated with a connector.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_templates({
  connector_arn: "ConnectorArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.templates #=> Array
resp.templates[0].arn #=> String
resp.templates[0].connector_arn #=> String
resp.templates[0].created_at #=> Time
resp.templates[0].definition.template_v2.certificate_validity.renewal_period.period #=> Integer
resp.templates[0].definition.template_v2.certificate_validity.renewal_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.templates[0].definition.template_v2.certificate_validity.validity_period.period #=> Integer
resp.templates[0].definition.template_v2.certificate_validity.validity_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.templates[0].definition.template_v2.enrollment_flags.enable_key_reuse_on_nt_token_keyset_storage_full #=> Boolean
resp.templates[0].definition.template_v2.enrollment_flags.include_symmetric_algorithms #=> Boolean
resp.templates[0].definition.template_v2.enrollment_flags.no_security_extension #=> Boolean
resp.templates[0].definition.template_v2.enrollment_flags.remove_invalid_certificate_from_personal_store #=> Boolean
resp.templates[0].definition.template_v2.enrollment_flags.user_interaction_required #=> Boolean
resp.templates[0].definition.template_v2.extensions.application_policies.critical #=> Boolean
resp.templates[0].definition.template_v2.extensions.application_policies.policies #=> Array
resp.templates[0].definition.template_v2.extensions.application_policies.policies[0].policy_object_identifier #=> String
resp.templates[0].definition.template_v2.extensions.application_policies.policies[0].policy_type #=> String, one of "ALL_APPLICATION_POLICIES", "ANY_PURPOSE", "ATTESTATION_IDENTITY_KEY_CERTIFICATE", "CERTIFICATE_REQUEST_AGENT", "CLIENT_AUTHENTICATION", "CODE_SIGNING", "CTL_USAGE", "DIGITAL_RIGHTS", "DIRECTORY_SERVICE_EMAIL_REPLICATION", "DISALLOWED_LIST", "DNS_SERVER_TRUST", "DOCUMENT_ENCRYPTION", "DOCUMENT_SIGNING", "DYNAMIC_CODE_GENERATOR", "EARLY_LAUNCH_ANTIMALWARE_DRIVER", "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "ENCLAVE", "ENCRYPTING_FILE_SYSTEM", "ENDORSEMENT_KEY_CERTIFICATE", "FILE_RECOVERY", "HAL_EXTENSION", "IP_SECURITY_END_SYSTEM", "IP_SECURITY_IKE_INTERMEDIATE", "IP_SECURITY_TUNNEL_TERMINATION", "IP_SECURITY_USER", "ISOLATED_USER_MODE", "KDC_AUTHENTICATION", "KERNEL_MODE_CODE_SIGNING", "KEY_PACK_LICENSES", "KEY_RECOVERY", "KEY_RECOVERY_AGENT", "LICENSE_SERVER_VERIFICATION", "LIFETIME_SIGNING", "MICROSOFT_PUBLISHER", "MICROSOFT_TIME_STAMPING", "MICROSOFT_TRUST_LIST_SIGNING", "OCSP_SIGNING", "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "PLATFORM_CERTIFICATE", "PREVIEW_BUILD_SIGNING", "PRIVATE_KEY_ARCHIVAL", "PROTECTED_PROCESS_LIGHT_VERIFICATION", "PROTECTED_PROCESS_VERIFICATION", "QUALIFIED_SUBORDINATION", "REVOKED_LIST_SIGNER", "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", "ROOT_LIST_SIGNER", "SECURE_EMAIL", "SERVER_AUTHENTICATION", "SMART_CARD_LOGIN", "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", "SPC_RELAXED_PE_MARKER_CHECK", "TIME_STAMPING", "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_VERIFICATION", "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", "WINDOWS_KITS_COMPONENT", "WINDOWS_RT_VERIFICATION", "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", "WINDOWS_STORE", "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "WINDOWS_TCB_COMPONENT", "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", "WINDOWS_UPDATE"
resp.templates[0].definition.template_v2.extensions.key_usage.critical #=> Boolean
resp.templates[0].definition.template_v2.extensions.key_usage.usage_flags.data_encipherment #=> Boolean
resp.templates[0].definition.template_v2.extensions.key_usage.usage_flags.digital_signature #=> Boolean
resp.templates[0].definition.template_v2.extensions.key_usage.usage_flags.key_agreement #=> Boolean
resp.templates[0].definition.template_v2.extensions.key_usage.usage_flags.key_encipherment #=> Boolean
resp.templates[0].definition.template_v2.extensions.key_usage.usage_flags.non_repudiation #=> Boolean
resp.templates[0].definition.template_v2.general_flags.auto_enrollment #=> Boolean
resp.templates[0].definition.template_v2.general_flags.machine_type #=> Boolean
resp.templates[0].definition.template_v2.private_key_attributes.crypto_providers #=> Array
resp.templates[0].definition.template_v2.private_key_attributes.crypto_providers[0] #=> String
resp.templates[0].definition.template_v2.private_key_attributes.key_spec #=> String, one of "KEY_EXCHANGE", "SIGNATURE"
resp.templates[0].definition.template_v2.private_key_attributes.minimal_key_length #=> Integer
resp.templates[0].definition.template_v2.private_key_flags.client_version #=> String, one of "WINDOWS_SERVER_2003", "WINDOWS_SERVER_2008", "WINDOWS_SERVER_2008_R2", "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016"
resp.templates[0].definition.template_v2.private_key_flags.exportable_key #=> Boolean
resp.templates[0].definition.template_v2.private_key_flags.strong_key_protection_required #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.require_common_name #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.require_directory_path #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.require_dns_as_cn #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.require_email #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.san_require_directory_guid #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.san_require_dns #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.san_require_domain_dns #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.san_require_email #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.san_require_spn #=> Boolean
resp.templates[0].definition.template_v2.subject_name_flags.san_require_upn #=> Boolean
resp.templates[0].definition.template_v2.superseded_templates #=> Array
resp.templates[0].definition.template_v2.superseded_templates[0] #=> String
resp.templates[0].definition.template_v3.certificate_validity.renewal_period.period #=> Integer
resp.templates[0].definition.template_v3.certificate_validity.renewal_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.templates[0].definition.template_v3.certificate_validity.validity_period.period #=> Integer
resp.templates[0].definition.template_v3.certificate_validity.validity_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.templates[0].definition.template_v3.enrollment_flags.enable_key_reuse_on_nt_token_keyset_storage_full #=> Boolean
resp.templates[0].definition.template_v3.enrollment_flags.include_symmetric_algorithms #=> Boolean
resp.templates[0].definition.template_v3.enrollment_flags.no_security_extension #=> Boolean
resp.templates[0].definition.template_v3.enrollment_flags.remove_invalid_certificate_from_personal_store #=> Boolean
resp.templates[0].definition.template_v3.enrollment_flags.user_interaction_required #=> Boolean
resp.templates[0].definition.template_v3.extensions.application_policies.critical #=> Boolean
resp.templates[0].definition.template_v3.extensions.application_policies.policies #=> Array
resp.templates[0].definition.template_v3.extensions.application_policies.policies[0].policy_object_identifier #=> String
resp.templates[0].definition.template_v3.extensions.application_policies.policies[0].policy_type #=> String, one of "ALL_APPLICATION_POLICIES", "ANY_PURPOSE", "ATTESTATION_IDENTITY_KEY_CERTIFICATE", "CERTIFICATE_REQUEST_AGENT", "CLIENT_AUTHENTICATION", "CODE_SIGNING", "CTL_USAGE", "DIGITAL_RIGHTS", "DIRECTORY_SERVICE_EMAIL_REPLICATION", "DISALLOWED_LIST", "DNS_SERVER_TRUST", "DOCUMENT_ENCRYPTION", "DOCUMENT_SIGNING", "DYNAMIC_CODE_GENERATOR", "EARLY_LAUNCH_ANTIMALWARE_DRIVER", "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "ENCLAVE", "ENCRYPTING_FILE_SYSTEM", "ENDORSEMENT_KEY_CERTIFICATE", "FILE_RECOVERY", "HAL_EXTENSION", "IP_SECURITY_END_SYSTEM", "IP_SECURITY_IKE_INTERMEDIATE", "IP_SECURITY_TUNNEL_TERMINATION", "IP_SECURITY_USER", "ISOLATED_USER_MODE", "KDC_AUTHENTICATION", "KERNEL_MODE_CODE_SIGNING", "KEY_PACK_LICENSES", "KEY_RECOVERY", "KEY_RECOVERY_AGENT", "LICENSE_SERVER_VERIFICATION", "LIFETIME_SIGNING", "MICROSOFT_PUBLISHER", "MICROSOFT_TIME_STAMPING", "MICROSOFT_TRUST_LIST_SIGNING", "OCSP_SIGNING", "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "PLATFORM_CERTIFICATE", "PREVIEW_BUILD_SIGNING", "PRIVATE_KEY_ARCHIVAL", "PROTECTED_PROCESS_LIGHT_VERIFICATION", "PROTECTED_PROCESS_VERIFICATION", "QUALIFIED_SUBORDINATION", "REVOKED_LIST_SIGNER", "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", "ROOT_LIST_SIGNER", "SECURE_EMAIL", "SERVER_AUTHENTICATION", "SMART_CARD_LOGIN", "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", "SPC_RELAXED_PE_MARKER_CHECK", "TIME_STAMPING", "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_VERIFICATION", "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", "WINDOWS_KITS_COMPONENT", "WINDOWS_RT_VERIFICATION", "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", "WINDOWS_STORE", "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "WINDOWS_TCB_COMPONENT", "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", "WINDOWS_UPDATE"
resp.templates[0].definition.template_v3.extensions.key_usage.critical #=> Boolean
resp.templates[0].definition.template_v3.extensions.key_usage.usage_flags.data_encipherment #=> Boolean
resp.templates[0].definition.template_v3.extensions.key_usage.usage_flags.digital_signature #=> Boolean
resp.templates[0].definition.template_v3.extensions.key_usage.usage_flags.key_agreement #=> Boolean
resp.templates[0].definition.template_v3.extensions.key_usage.usage_flags.key_encipherment #=> Boolean
resp.templates[0].definition.template_v3.extensions.key_usage.usage_flags.non_repudiation #=> Boolean
resp.templates[0].definition.template_v3.general_flags.auto_enrollment #=> Boolean
resp.templates[0].definition.template_v3.general_flags.machine_type #=> Boolean
resp.templates[0].definition.template_v3.hash_algorithm #=> String, one of "SHA256", "SHA384", "SHA512"
resp.templates[0].definition.template_v3.private_key_attributes.algorithm #=> String, one of "RSA", "ECDH_P256", "ECDH_P384", "ECDH_P521"
resp.templates[0].definition.template_v3.private_key_attributes.crypto_providers #=> Array
resp.templates[0].definition.template_v3.private_key_attributes.crypto_providers[0] #=> String
resp.templates[0].definition.template_v3.private_key_attributes.key_spec #=> String, one of "KEY_EXCHANGE", "SIGNATURE"
resp.templates[0].definition.template_v3.private_key_attributes.key_usage_property.property_flags.decrypt #=> Boolean
resp.templates[0].definition.template_v3.private_key_attributes.key_usage_property.property_flags.key_agreement #=> Boolean
resp.templates[0].definition.template_v3.private_key_attributes.key_usage_property.property_flags.sign #=> Boolean
resp.templates[0].definition.template_v3.private_key_attributes.key_usage_property.property_type #=> String, one of "ALL"
resp.templates[0].definition.template_v3.private_key_attributes.minimal_key_length #=> Integer
resp.templates[0].definition.template_v3.private_key_flags.client_version #=> String, one of "WINDOWS_SERVER_2008", "WINDOWS_SERVER_2008_R2", "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016"
resp.templates[0].definition.template_v3.private_key_flags.exportable_key #=> Boolean
resp.templates[0].definition.template_v3.private_key_flags.require_alternate_signature_algorithm #=> Boolean
resp.templates[0].definition.template_v3.private_key_flags.strong_key_protection_required #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.require_common_name #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.require_directory_path #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.require_dns_as_cn #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.require_email #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.san_require_directory_guid #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.san_require_dns #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.san_require_domain_dns #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.san_require_email #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.san_require_spn #=> Boolean
resp.templates[0].definition.template_v3.subject_name_flags.san_require_upn #=> Boolean
resp.templates[0].definition.template_v3.superseded_templates #=> Array
resp.templates[0].definition.template_v3.superseded_templates[0] #=> String
resp.templates[0].definition.template_v4.certificate_validity.renewal_period.period #=> Integer
resp.templates[0].definition.template_v4.certificate_validity.renewal_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.templates[0].definition.template_v4.certificate_validity.validity_period.period #=> Integer
resp.templates[0].definition.template_v4.certificate_validity.validity_period.period_type #=> String, one of "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS"
resp.templates[0].definition.template_v4.enrollment_flags.enable_key_reuse_on_nt_token_keyset_storage_full #=> Boolean
resp.templates[0].definition.template_v4.enrollment_flags.include_symmetric_algorithms #=> Boolean
resp.templates[0].definition.template_v4.enrollment_flags.no_security_extension #=> Boolean
resp.templates[0].definition.template_v4.enrollment_flags.remove_invalid_certificate_from_personal_store #=> Boolean
resp.templates[0].definition.template_v4.enrollment_flags.user_interaction_required #=> Boolean
resp.templates[0].definition.template_v4.extensions.application_policies.critical #=> Boolean
resp.templates[0].definition.template_v4.extensions.application_policies.policies #=> Array
resp.templates[0].definition.template_v4.extensions.application_policies.policies[0].policy_object_identifier #=> String
resp.templates[0].definition.template_v4.extensions.application_policies.policies[0].policy_type #=> String, one of "ALL_APPLICATION_POLICIES", "ANY_PURPOSE", "ATTESTATION_IDENTITY_KEY_CERTIFICATE", "CERTIFICATE_REQUEST_AGENT", "CLIENT_AUTHENTICATION", "CODE_SIGNING", "CTL_USAGE", "DIGITAL_RIGHTS", "DIRECTORY_SERVICE_EMAIL_REPLICATION", "DISALLOWED_LIST", "DNS_SERVER_TRUST", "DOCUMENT_ENCRYPTION", "DOCUMENT_SIGNING", "DYNAMIC_CODE_GENERATOR", "EARLY_LAUNCH_ANTIMALWARE_DRIVER", "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "ENCLAVE", "ENCRYPTING_FILE_SYSTEM", "ENDORSEMENT_KEY_CERTIFICATE", "FILE_RECOVERY", "HAL_EXTENSION", "IP_SECURITY_END_SYSTEM", "IP_SECURITY_IKE_INTERMEDIATE", "IP_SECURITY_TUNNEL_TERMINATION", "IP_SECURITY_USER", "ISOLATED_USER_MODE", "KDC_AUTHENTICATION", "KERNEL_MODE_CODE_SIGNING", "KEY_PACK_LICENSES", "KEY_RECOVERY", "KEY_RECOVERY_AGENT", "LICENSE_SERVER_VERIFICATION", "LIFETIME_SIGNING", "MICROSOFT_PUBLISHER", "MICROSOFT_TIME_STAMPING", "MICROSOFT_TRUST_LIST_SIGNING", "OCSP_SIGNING", "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "PLATFORM_CERTIFICATE", "PREVIEW_BUILD_SIGNING", "PRIVATE_KEY_ARCHIVAL", "PROTECTED_PROCESS_LIGHT_VERIFICATION", "PROTECTED_PROCESS_VERIFICATION", "QUALIFIED_SUBORDINATION", "REVOKED_LIST_SIGNER", "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", "ROOT_LIST_SIGNER", "SECURE_EMAIL", "SERVER_AUTHENTICATION", "SMART_CARD_LOGIN", "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", "SPC_RELAXED_PE_MARKER_CHECK", "TIME_STAMPING", "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", "WINDOWS_HARDWARE_DRIVER_VERIFICATION", "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", "WINDOWS_KITS_COMPONENT", "WINDOWS_RT_VERIFICATION", "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", "WINDOWS_STORE", "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", "WINDOWS_TCB_COMPONENT", "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", "WINDOWS_UPDATE"
resp.templates[0].definition.template_v4.extensions.key_usage.critical #=> Boolean
resp.templates[0].definition.template_v4.extensions.key_usage.usage_flags.data_encipherment #=> Boolean
resp.templates[0].definition.template_v4.extensions.key_usage.usage_flags.digital_signature #=> Boolean
resp.templates[0].definition.template_v4.extensions.key_usage.usage_flags.key_agreement #=> Boolean
resp.templates[0].definition.template_v4.extensions.key_usage.usage_flags.key_encipherment #=> Boolean
resp.templates[0].definition.template_v4.extensions.key_usage.usage_flags.non_repudiation #=> Boolean
resp.templates[0].definition.template_v4.general_flags.auto_enrollment #=> Boolean
resp.templates[0].definition.template_v4.general_flags.machine_type #=> Boolean
resp.templates[0].definition.template_v4.hash_algorithm #=> String, one of "SHA256", "SHA384", "SHA512"
resp.templates[0].definition.template_v4.private_key_attributes.algorithm #=> String, one of "RSA", "ECDH_P256", "ECDH_P384", "ECDH_P521"
resp.templates[0].definition.template_v4.private_key_attributes.crypto_providers #=> Array
resp.templates[0].definition.template_v4.private_key_attributes.crypto_providers[0] #=> String
resp.templates[0].definition.template_v4.private_key_attributes.key_spec #=> String, one of "KEY_EXCHANGE", "SIGNATURE"
resp.templates[0].definition.template_v4.private_key_attributes.key_usage_property.property_flags.decrypt #=> Boolean
resp.templates[0].definition.template_v4.private_key_attributes.key_usage_property.property_flags.key_agreement #=> Boolean
resp.templates[0].definition.template_v4.private_key_attributes.key_usage_property.property_flags.sign #=> Boolean
resp.templates[0].definition.template_v4.private_key_attributes.key_usage_property.property_type #=> String, one of "ALL"
resp.templates[0].definition.template_v4.private_key_attributes.minimal_key_length #=> Integer
resp.templates[0].definition.template_v4.private_key_flags.client_version #=> String, one of "WINDOWS_SERVER_2012", "WINDOWS_SERVER_2012_R2", "WINDOWS_SERVER_2016"
resp.templates[0].definition.template_v4.private_key_flags.exportable_key #=> Boolean
resp.templates[0].definition.template_v4.private_key_flags.require_alternate_signature_algorithm #=> Boolean
resp.templates[0].definition.template_v4.private_key_flags.require_same_key_renewal #=> Boolean
resp.templates[0].definition.template_v4.private_key_flags.strong_key_protection_required #=> Boolean
resp.templates[0].definition.template_v4.private_key_flags.use_legacy_provider #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.require_common_name #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.require_directory_path #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.require_dns_as_cn #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.require_email #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.san_require_directory_guid #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.san_require_dns #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.san_require_domain_dns #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.san_require_email #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.san_require_spn #=> Boolean
resp.templates[0].definition.template_v4.subject_name_flags.san_require_upn #=> Boolean
resp.templates[0].definition.template_v4.superseded_templates #=> Array
resp.templates[0].definition.template_v4.superseded_templates[0] #=> String
resp.templates[0].name #=> String
resp.templates[0].object_identifier #=> String
resp.templates[0].policy_schema #=> Integer
resp.templates[0].revision.major_revision #=> Integer
resp.templates[0].revision.minor_revision #=> Integer
resp.templates[0].status #=> String, one of "ACTIVE", "DELETING"
resp.templates[0].updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :connector_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you called [CreateConnector].

    [1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html

  • :max_results (Integer) —

    Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the ‘NextToken` element is sent in the response. Use this `NextToken` value in a subsequent request to retrieve additional items.

  • :next_token (String) —

    Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the ‘NextToken` parameter from the response you just received.

Returns:

See Also:



1937
1938
1939
1940
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1937

def list_templates(params = {}, options = {})
  req = build_request(:list_templates, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to your resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "String" => "String",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you created the resource.

  • :tags (required, Hash<String,String>) —

    Metadata assigned to a directory registration consisting of a key-value pair.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1967
1968
1969
1970
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1967

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from your resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you created the resource.

  • :tag_keys (required, Array<String>) —

    Specifies a list of tag keys that you want to remove from the specified resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1995
1996
1997
1998
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 1995

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_template(params = {}) ⇒ Struct

Update template configuration to define the information included in certificates.

Examples:

Request syntax with placeholder values


resp = client.update_template({
  definition: {
    template_v2: {
      certificate_validity: { # required
        renewal_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
        validity_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
      },
      enrollment_flags: { # required
        enable_key_reuse_on_nt_token_keyset_storage_full: false,
        include_symmetric_algorithms: false,
        no_security_extension: false,
        remove_invalid_certificate_from_personal_store: false,
        user_interaction_required: false,
      },
      extensions: { # required
        application_policies: {
          critical: false,
          policies: [ # required
            {
              policy_object_identifier: "CustomObjectIdentifier",
              policy_type: "ALL_APPLICATION_POLICIES", # accepts ALL_APPLICATION_POLICIES, ANY_PURPOSE, ATTESTATION_IDENTITY_KEY_CERTIFICATE, CERTIFICATE_REQUEST_AGENT, CLIENT_AUTHENTICATION, CODE_SIGNING, CTL_USAGE, DIGITAL_RIGHTS, DIRECTORY_SERVICE_EMAIL_REPLICATION, DISALLOWED_LIST, DNS_SERVER_TRUST, DOCUMENT_ENCRYPTION, DOCUMENT_SIGNING, DYNAMIC_CODE_GENERATOR, EARLY_LAUNCH_ANTIMALWARE_DRIVER, EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, ENCLAVE, ENCRYPTING_FILE_SYSTEM, ENDORSEMENT_KEY_CERTIFICATE, FILE_RECOVERY, HAL_EXTENSION, IP_SECURITY_END_SYSTEM, IP_SECURITY_IKE_INTERMEDIATE, IP_SECURITY_TUNNEL_TERMINATION, IP_SECURITY_USER, ISOLATED_USER_MODE, KDC_AUTHENTICATION, KERNEL_MODE_CODE_SIGNING, KEY_PACK_LICENSES, KEY_RECOVERY, KEY_RECOVERY_AGENT, LICENSE_SERVER_VERIFICATION, LIFETIME_SIGNING, MICROSOFT_PUBLISHER, MICROSOFT_TIME_STAMPING, MICROSOFT_TRUST_LIST_SIGNING, OCSP_SIGNING, OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, PLATFORM_CERTIFICATE, PREVIEW_BUILD_SIGNING, PRIVATE_KEY_ARCHIVAL, PROTECTED_PROCESS_LIGHT_VERIFICATION, PROTECTED_PROCESS_VERIFICATION, QUALIFIED_SUBORDINATION, REVOKED_LIST_SIGNER, ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION, ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION, ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL, ROOT_LIST_SIGNER, SECURE_EMAIL, SERVER_AUTHENTICATION, SMART_CARD_LOGIN, SPC_ENCRYPTED_DIGEST_RETRY_COUNT, SPC_RELAXED_PE_MARKER_CHECK, TIME_STAMPING, WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_VERIFICATION, WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION, WINDOWS_KITS_COMPONENT, WINDOWS_RT_VERIFICATION, WINDOWS_SOFTWARE_EXTENSION_VERIFICATION, WINDOWS_STORE, WINDOWS_SYSTEM_COMPONENT_VERIFICATION, WINDOWS_TCB_COMPONENT, WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT, WINDOWS_UPDATE
            },
          ],
        },
        key_usage: { # required
          critical: false,
          usage_flags: { # required
            data_encipherment: false,
            digital_signature: false,
            key_agreement: false,
            key_encipherment: false,
            non_repudiation: false,
          },
        },
      },
      general_flags: { # required
        auto_enrollment: false,
        machine_type: false,
      },
      private_key_attributes: { # required
        crypto_providers: ["CryptoProvidersListMemberString"],
        key_spec: "KEY_EXCHANGE", # required, accepts KEY_EXCHANGE, SIGNATURE
        minimal_key_length: 1, # required
      },
      private_key_flags: { # required
        client_version: "WINDOWS_SERVER_2003", # required, accepts WINDOWS_SERVER_2003, WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016
        exportable_key: false,
        strong_key_protection_required: false,
      },
      subject_name_flags: { # required
        require_common_name: false,
        require_directory_path: false,
        require_dns_as_cn: false,
        require_email: false,
        san_require_directory_guid: false,
        san_require_dns: false,
        san_require_domain_dns: false,
        san_require_email: false,
        san_require_spn: false,
        san_require_upn: false,
      },
      superseded_templates: ["TemplateName"],
    },
    template_v3: {
      certificate_validity: { # required
        renewal_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
        validity_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
      },
      enrollment_flags: { # required
        enable_key_reuse_on_nt_token_keyset_storage_full: false,
        include_symmetric_algorithms: false,
        no_security_extension: false,
        remove_invalid_certificate_from_personal_store: false,
        user_interaction_required: false,
      },
      extensions: { # required
        application_policies: {
          critical: false,
          policies: [ # required
            {
              policy_object_identifier: "CustomObjectIdentifier",
              policy_type: "ALL_APPLICATION_POLICIES", # accepts ALL_APPLICATION_POLICIES, ANY_PURPOSE, ATTESTATION_IDENTITY_KEY_CERTIFICATE, CERTIFICATE_REQUEST_AGENT, CLIENT_AUTHENTICATION, CODE_SIGNING, CTL_USAGE, DIGITAL_RIGHTS, DIRECTORY_SERVICE_EMAIL_REPLICATION, DISALLOWED_LIST, DNS_SERVER_TRUST, DOCUMENT_ENCRYPTION, DOCUMENT_SIGNING, DYNAMIC_CODE_GENERATOR, EARLY_LAUNCH_ANTIMALWARE_DRIVER, EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, ENCLAVE, ENCRYPTING_FILE_SYSTEM, ENDORSEMENT_KEY_CERTIFICATE, FILE_RECOVERY, HAL_EXTENSION, IP_SECURITY_END_SYSTEM, IP_SECURITY_IKE_INTERMEDIATE, IP_SECURITY_TUNNEL_TERMINATION, IP_SECURITY_USER, ISOLATED_USER_MODE, KDC_AUTHENTICATION, KERNEL_MODE_CODE_SIGNING, KEY_PACK_LICENSES, KEY_RECOVERY, KEY_RECOVERY_AGENT, LICENSE_SERVER_VERIFICATION, LIFETIME_SIGNING, MICROSOFT_PUBLISHER, MICROSOFT_TIME_STAMPING, MICROSOFT_TRUST_LIST_SIGNING, OCSP_SIGNING, OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, PLATFORM_CERTIFICATE, PREVIEW_BUILD_SIGNING, PRIVATE_KEY_ARCHIVAL, PROTECTED_PROCESS_LIGHT_VERIFICATION, PROTECTED_PROCESS_VERIFICATION, QUALIFIED_SUBORDINATION, REVOKED_LIST_SIGNER, ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION, ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION, ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL, ROOT_LIST_SIGNER, SECURE_EMAIL, SERVER_AUTHENTICATION, SMART_CARD_LOGIN, SPC_ENCRYPTED_DIGEST_RETRY_COUNT, SPC_RELAXED_PE_MARKER_CHECK, TIME_STAMPING, WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_VERIFICATION, WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION, WINDOWS_KITS_COMPONENT, WINDOWS_RT_VERIFICATION, WINDOWS_SOFTWARE_EXTENSION_VERIFICATION, WINDOWS_STORE, WINDOWS_SYSTEM_COMPONENT_VERIFICATION, WINDOWS_TCB_COMPONENT, WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT, WINDOWS_UPDATE
            },
          ],
        },
        key_usage: { # required
          critical: false,
          usage_flags: { # required
            data_encipherment: false,
            digital_signature: false,
            key_agreement: false,
            key_encipherment: false,
            non_repudiation: false,
          },
        },
      },
      general_flags: { # required
        auto_enrollment: false,
        machine_type: false,
      },
      hash_algorithm: "SHA256", # required, accepts SHA256, SHA384, SHA512
      private_key_attributes: { # required
        algorithm: "RSA", # required, accepts RSA, ECDH_P256, ECDH_P384, ECDH_P521
        crypto_providers: ["CryptoProvidersListMemberString"],
        key_spec: "KEY_EXCHANGE", # required, accepts KEY_EXCHANGE, SIGNATURE
        key_usage_property: { # required
          property_flags: {
            decrypt: false,
            key_agreement: false,
            sign: false,
          },
          property_type: "ALL", # accepts ALL
        },
        minimal_key_length: 1, # required
      },
      private_key_flags: { # required
        client_version: "WINDOWS_SERVER_2008", # required, accepts WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016
        exportable_key: false,
        require_alternate_signature_algorithm: false,
        strong_key_protection_required: false,
      },
      subject_name_flags: { # required
        require_common_name: false,
        require_directory_path: false,
        require_dns_as_cn: false,
        require_email: false,
        san_require_directory_guid: false,
        san_require_dns: false,
        san_require_domain_dns: false,
        san_require_email: false,
        san_require_spn: false,
        san_require_upn: false,
      },
      superseded_templates: ["TemplateName"],
    },
    template_v4: {
      certificate_validity: { # required
        renewal_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
        validity_period: { # required
          period: 1, # required
          period_type: "HOURS", # required, accepts HOURS, DAYS, WEEKS, MONTHS, YEARS
        },
      },
      enrollment_flags: { # required
        enable_key_reuse_on_nt_token_keyset_storage_full: false,
        include_symmetric_algorithms: false,
        no_security_extension: false,
        remove_invalid_certificate_from_personal_store: false,
        user_interaction_required: false,
      },
      extensions: { # required
        application_policies: {
          critical: false,
          policies: [ # required
            {
              policy_object_identifier: "CustomObjectIdentifier",
              policy_type: "ALL_APPLICATION_POLICIES", # accepts ALL_APPLICATION_POLICIES, ANY_PURPOSE, ATTESTATION_IDENTITY_KEY_CERTIFICATE, CERTIFICATE_REQUEST_AGENT, CLIENT_AUTHENTICATION, CODE_SIGNING, CTL_USAGE, DIGITAL_RIGHTS, DIRECTORY_SERVICE_EMAIL_REPLICATION, DISALLOWED_LIST, DNS_SERVER_TRUST, DOCUMENT_ENCRYPTION, DOCUMENT_SIGNING, DYNAMIC_CODE_GENERATOR, EARLY_LAUNCH_ANTIMALWARE_DRIVER, EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, ENCLAVE, ENCRYPTING_FILE_SYSTEM, ENDORSEMENT_KEY_CERTIFICATE, FILE_RECOVERY, HAL_EXTENSION, IP_SECURITY_END_SYSTEM, IP_SECURITY_IKE_INTERMEDIATE, IP_SECURITY_TUNNEL_TERMINATION, IP_SECURITY_USER, ISOLATED_USER_MODE, KDC_AUTHENTICATION, KERNEL_MODE_CODE_SIGNING, KEY_PACK_LICENSES, KEY_RECOVERY, KEY_RECOVERY_AGENT, LICENSE_SERVER_VERIFICATION, LIFETIME_SIGNING, MICROSOFT_PUBLISHER, MICROSOFT_TIME_STAMPING, MICROSOFT_TRUST_LIST_SIGNING, OCSP_SIGNING, OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION, PLATFORM_CERTIFICATE, PREVIEW_BUILD_SIGNING, PRIVATE_KEY_ARCHIVAL, PROTECTED_PROCESS_LIGHT_VERIFICATION, PROTECTED_PROCESS_VERIFICATION, QUALIFIED_SUBORDINATION, REVOKED_LIST_SIGNER, ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION, ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION, ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL, ROOT_LIST_SIGNER, SECURE_EMAIL, SERVER_AUTHENTICATION, SMART_CARD_LOGIN, SPC_ENCRYPTED_DIGEST_RETRY_COUNT, SPC_RELAXED_PE_MARKER_CHECK, TIME_STAMPING, WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION, WINDOWS_HARDWARE_DRIVER_VERIFICATION, WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION, WINDOWS_KITS_COMPONENT, WINDOWS_RT_VERIFICATION, WINDOWS_SOFTWARE_EXTENSION_VERIFICATION, WINDOWS_STORE, WINDOWS_SYSTEM_COMPONENT_VERIFICATION, WINDOWS_TCB_COMPONENT, WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT, WINDOWS_UPDATE
            },
          ],
        },
        key_usage: { # required
          critical: false,
          usage_flags: { # required
            data_encipherment: false,
            digital_signature: false,
            key_agreement: false,
            key_encipherment: false,
            non_repudiation: false,
          },
        },
      },
      general_flags: { # required
        auto_enrollment: false,
        machine_type: false,
      },
      hash_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512
      private_key_attributes: { # required
        algorithm: "RSA", # accepts RSA, ECDH_P256, ECDH_P384, ECDH_P521
        crypto_providers: ["CryptoProvidersListMemberString"],
        key_spec: "KEY_EXCHANGE", # required, accepts KEY_EXCHANGE, SIGNATURE
        key_usage_property: {
          property_flags: {
            decrypt: false,
            key_agreement: false,
            sign: false,
          },
          property_type: "ALL", # accepts ALL
        },
        minimal_key_length: 1, # required
      },
      private_key_flags: { # required
        client_version: "WINDOWS_SERVER_2012", # required, accepts WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016
        exportable_key: false,
        require_alternate_signature_algorithm: false,
        require_same_key_renewal: false,
        strong_key_protection_required: false,
        use_legacy_provider: false,
      },
      subject_name_flags: { # required
        require_common_name: false,
        require_directory_path: false,
        require_dns_as_cn: false,
        require_email: false,
        san_require_directory_guid: false,
        san_require_dns: false,
        san_require_domain_dns: false,
        san_require_email: false,
        san_require_spn: false,
        san_require_upn: false,
      },
      superseded_templates: ["TemplateName"],
    },
  },
  reenroll_all_certificate_holders: false,
  template_arn: "TemplateArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :definition (Types::TemplateDefinition) —

    Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

  • :reenroll_all_certificate_holders (Boolean) —

    This setting allows the major version of a template to be increased automatically. All members of Active Directory groups that are allowed to enroll with a template will receive a new certificate issued using that template.

  • :template_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate].

    [1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2263
2264
2265
2266
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 2263

def update_template(params = {}, options = {})
  req = build_request(:update_template, params)
  req.send_request(options)
end

#update_template_group_access_control_entry(params = {}) ⇒ Struct

Update a group access control entry you created using [CreateTemplateGroupAccessControlEntry].

[1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplateGroupAccessControlEntry.html

Examples:

Request syntax with placeholder values


resp = client.update_template_group_access_control_entry({
  access_rights: {
    auto_enroll: "ALLOW", # accepts ALLOW, DENY
    enroll: "ALLOW", # accepts ALLOW, DENY
  },
  group_display_name: "DisplayName",
  group_security_identifier: "GroupSecurityIdentifier", # required
  template_arn: "TemplateArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_rights (Types::AccessRights) —

    Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template.

  • :group_display_name (String) —

    Name of the Active Directory group. This name does not need to match the group name in Active Directory.

  • :group_security_identifier (required, String) —

    Security identifier (SID) of the group object from Active Directory. The SID starts with “S-”.

  • :template_arn (required, String) —

    The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate].

    [1]: docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2313
2314
2315
2316
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 2313

def update_template_group_access_control_entry(params = {}, options = {})
  req = build_request(:update_template_group_access_control_entry, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2342
2343
2344
 
# File 'lib/aws-sdk-pcaconnectorad/client.rb', line 2342

def waiter_names
  []
end