Skip to content

create_template_group_access_control_entry async

create_template_group_access_control_entry(
    template_arn: TemplateArn,
    group_security_identifier: GroupSecurityIdentifier,
    group_display_name: DisplayName,
    access_rights: AccessRights,
    *,
    config_overrides: Optional[AsyncPcaConnectorAdClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> None

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

Parameters:

  • template_arn (TemplateArn) –

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

  • group_security_identifier (GroupSecurityIdentifier) –

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

  • group_display_name (DisplayName) –

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

  • access_rights (AccessRights) –

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

  • client_token (Optional[ClientToken], default: None ) –

    Idempotency token.

Raises:

  • AccessDeniedException –

    You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.

  • ConflictException –

    This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

  • InternalServerException –

    The request processing has failed because of an unknown error, exception or failure with an internal server.

  • ResourceNotFoundException –

    The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

  • ServiceQuotaExceededException –

    Request would cause a service quota to be exceeded.

  • ThrottlingException –

    The limit on the number of requests per second was exceeded.

  • ValidationException –

    An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_pca_connector_ad/_services/async_pca_connector_ad.py
async def create_template_group_access_control_entry(
    self,
    template_arn: "capo_pca_connector_ad.types.template_arn.TemplateArn",
    group_security_identifier: "capo_pca_connector_ad.types.group_security_identifier.GroupSecurityIdentifier",
    group_display_name: "capo_pca_connector_ad.types.display_name.DisplayName",
    access_rights: "capo_pca_connector_ad.types.access_rights.AccessRights",
    *,
    config_overrides: Optional[AsyncPcaConnectorAdClientConfig] = None,
    client_token: Optional[
        "capo_pca_connector_ad.types.client_token.ClientToken"
    ] = None,
) -> None:
    """<p>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).</p>

    Args:
        template_arn: <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
        group_security_identifier: <p>Security identifier (SID) of the group object from Active Directory. The SID starts with "S-".</p>
        group_display_name: <p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>
        access_rights: <p> Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template.</p>
        client_token: <p>Idempotency token.</p>

    Raises:
        capo_pca_connector_ad.errors.access_denied_exception.AccessDeniedException: <p>You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account. </p>
        capo_pca_connector_ad.errors.conflict_exception.ConflictException: <p>This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.</p>
        capo_pca_connector_ad.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server. </p>
        capo_pca_connector_ad.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.</p>
        capo_pca_connector_ad.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
        capo_pca_connector_ad.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded. </p>
        capo_pca_connector_ad.errors.validation_exception.ValidationException: <p>An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid. </p>
        capo_pca_connector_ad.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pca_connector_ad.types.create_template_group_access_control_entry_request.CreateTemplateGroupAccessControlEntryRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_pca_connector_ad._operations.pca_connector_ad.create_template_group_access_control_entry

        (
            output,
            http_response,
        ) = await capo_pca_connector_ad._operations.pca_connector_ad.create_template_group_access_control_entry.async_create_template_group_access_control_entry(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateTemplateGroupAccessControlEntry")
    )
    input_: capo_pca_connector_ad.types.create_template_group_access_control_entry_request.CreateTemplateGroupAccessControlEntryRequest = {
        "template_arn": template_arn,
        "group_security_identifier": group_security_identifier,
        "group_display_name": group_display_name,
        "access_rights": access_rights,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output