CreateChallenge

$result = $client->createChallenge([/* ... */]);
$promise = $client->createChallengeAsync([/* ... */]);

For general-purpose connectors. Creates a challenge password for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call ListConnectors.

To create additional challenge passwords for the connector, call CreateChallenge again. We recommend frequently rotating your challenge passwords.

Parameter Syntax

$result = $client->createChallenge([
    'ClientToken' => '<string>',
    'ConnectorArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Challenge' => [
        'Arn' => '<string>',
        'ConnectorArn' => '<string>',
        'CreatedAt' => <DateTime>,
        'Password' => '<string>',
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

BadRequestException:

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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 can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

CreateConnector

$result = $client->createConnector([/* ... */]);
$promise = $client->createConnectorAsync([/* ... */]);

Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.

Parameter Syntax

$result = $client->createConnector([
    'CertificateAuthorityArn' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'MobileDeviceManagement' => [
        'Intune' => [
            'AzureApplicationId' => '<string>', // REQUIRED
            'Domain' => '<string>', // REQUIRED
        ],
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ConnectorArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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 can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

DeleteChallenge

$result = $client->deleteChallenge([/* ... */]);
$promise = $client->deleteChallengeAsync([/* ... */]);

Deletes the specified Challenge.

Parameter Syntax

$result = $client->deleteChallenge([
    'ChallengeArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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 can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

DeleteConnector

$result = $client->deleteConnector([/* ... */]);
$promise = $client->deleteConnectorAsync([/* ... */]);

Deletes the specified Connector. This operation also deletes any challenges associated with the connector.

Parameter Syntax

$result = $client->deleteConnector([
    'ConnectorArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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 can't be completed for one of the following reasons because the requested resource was being concurrently modified by another request.

GetChallengeMetadata

$result = $client->getChallengeMetadata([/* ... */]);
$promise = $client->getChallengeMetadataAsync([/* ... */]);

Retrieves the metadata for the specified Challenge.

Parameter Syntax

$result = $client->getChallengeMetadata([
    'ChallengeArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChallengeMetadata' => [
        'Arn' => '<string>',
        'ConnectorArn' => '<string>',
        'CreatedAt' => <DateTime>,
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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.

GetChallengePassword

$result = $client->getChallengePassword([/* ... */]);
$promise = $client->getChallengePasswordAsync([/* ... */]);

Retrieves the challenge password for the specified Challenge.

Parameter Syntax

$result = $client->getChallengePassword([
    'ChallengeArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Password' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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.

GetConnector

$result = $client->getConnector([/* ... */]);
$promise = $client->getConnectorAsync([/* ... */]);

Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.

Parameter Syntax

$result = $client->getConnector([
    'ConnectorArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Connector' => [
        'Arn' => '<string>',
        'CertificateAuthorityArn' => '<string>',
        'CreatedAt' => <DateTime>,
        'Endpoint' => '<string>',
        'MobileDeviceManagement' => [
            'Intune' => [
                'AzureApplicationId' => '<string>',
                'Domain' => '<string>',
            ],
        ],
        'OpenIdConfiguration' => [
            'Audience' => '<string>',
            'Issuer' => '<string>',
            'Subject' => '<string>',
        ],
        'Status' => 'CREATING|ACTIVE|DELETING|FAILED',
        'StatusReason' => 'INTERNAL_FAILURE|PRIVATECA_ACCESS_DENIED|PRIVATECA_INVALID_STATE|PRIVATECA_RESOURCE_NOT_FOUND',
        'Type' => 'GENERAL_PURPOSE|INTUNE',
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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.

ListChallengeMetadata

$result = $client->listChallengeMetadata([/* ... */]);
$promise = $client->listChallengeMetadataAsync([/* ... */]);

Retrieves the challenge metadata for the specified ARN.

Parameter Syntax

$result = $client->listChallengeMetadata([
    'ConnectorArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Challenges' => [
        [
            'Arn' => '<string>',
            'ConnectorArn' => '<string>',
            'CreatedAt' => <DateTime>,
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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.

ListConnectors

$result = $client->listConnectors([/* ... */]);
$promise = $client->listConnectorsAsync([/* ... */]);

Lists the connectors belonging to your Amazon Web Services account.

Parameter Syntax

$result = $client->listConnectors([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Connectors' => [
        [
            'Arn' => '<string>',
            'CertificateAuthorityArn' => '<string>',
            'CreatedAt' => <DateTime>,
            'Endpoint' => '<string>',
            'MobileDeviceManagement' => [
                'Intune' => [
                    'AzureApplicationId' => '<string>',
                    'Domain' => '<string>',
                ],
            ],
            'OpenIdConfiguration' => [
                'Audience' => '<string>',
                'Issuer' => '<string>',
                'Subject' => '<string>',
            ],
            'Status' => 'CREATING|ACTIVE|DELETING|FAILED',
            'StatusReason' => 'INTERNAL_FAILURE|PRIVATECA_ACCESS_DENIED|PRIVATECA_INVALID_STATE|PRIVATECA_RESOURCE_NOT_FOUND',
            'Type' => 'GENERAL_PURPOSE|INTUNE',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves the tags associated with the specified resource. Tags are key-value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to your resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from your resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent resource. The resource might be incorrectly specified, or it might have a status other than ACTIVE.

InternalServerException:

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

ValidationException:

An input validation error occurred. For example, invalid characters in a name tag, or an invalid pagination token.

ThrottlingException:

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

AccessDeniedException:

You can receive this error if you attempt to perform an operation and 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.