WorkSpaces / Client / modify_certificate_based_auth_properties

modify_certificate_based_auth_properties

WorkSpaces.Client.modify_certificate_based_auth_properties(**kwargs)

Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

See also: AWS API Documentation

Request Syntax

response = client.modify_certificate_based_auth_properties(
    ResourceId='string',
    CertificateBasedAuthProperties={
        'Status': 'DISABLED'|'ENABLED',
        'CertificateAuthorityArn': 'string'
    },
    PropertiesToDelete=[
        'CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN',
    ]
)

Parameters:

• ResourceId (string) –

  [REQUIRED]

  The resource identifiers, in the form of directory IDs.

• CertificateBasedAuthProperties (dict) –

  The properties of the certificate-based authentication.

  • Status (string) –

    The status of the certificate-based authentication properties.

  • CertificateAuthorityArn (string) –

    The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.

• PropertiesToDelete (list) –

  The properties of the certificate-based authentication you want to delete.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• WorkSpaces.Client.exceptions.AccessDeniedException

• WorkSpaces.Client.exceptions.InvalidParameterValuesException

• WorkSpaces.Client.exceptions.OperationNotSupportedException

• WorkSpaces.Client.exceptions.ResourceNotFoundException