2023/12/14 - AWS IoT - 5 new api methods
Changes This release adds the ability to self-manage certificate signing in AWS IoT Core fleet provisioning using the new certificate provider resource.
Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide .
Requires permission to access the CreateCertificateProvider action.
Warning
After you create a certificate provider, the behavior of ` CreateCertificateFromCsr API for fleet provisioning <https://docs.aws.amazon.com/iot/latest/developerguide/fleet-provision-api.html#create-cert-csr>`__ will change and all API calls to CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can take up to a few minutes for this behavior to change after a certificate provider is created.
See also: AWS API Documentation
Request Syntax
client.create_certificate_provider(
certificateProviderName='string',
lambdaFunctionArn='string',
accountDefaultForOperations=[
'CreateCertificateFromCsr',
],
clientToken='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the certificate provider.
string
[REQUIRED]
The ARN of the Lambda function that defines the authentication logic.
list
[REQUIRED]
A list of the operations that the certificate provider will use to generate certificates. Valid value: CreateCertificateFromCsr .
(string) --
string
A string that you can optionally pass in the CreateCertificateProvider request to make sure the request is idempotent.
This field is autopopulated if not provided.
list
Metadata which can be used to manage the certificate provider.
(dict) --
A set of key/value pairs that are used to manage the resource.
Key (string) -- [REQUIRED]
The tag's key.
Value (string) --
The tag's value.
dict
Response Syntax
{
'certificateProviderName': 'string',
'certificateProviderArn': 'string'
}
Response Structure
(dict) --
certificateProviderName (string) --
The name of the certificate provider.
certificateProviderArn (string) --
The ARN of the certificate provider.
Updates a certificate provider.
Requires permission to access the UpdateCertificateProvider action.
See also: AWS API Documentation
Request Syntax
client.update_certificate_provider(
certificateProviderName='string',
lambdaFunctionArn='string',
accountDefaultForOperations=[
'CreateCertificateFromCsr',
]
)
string
[REQUIRED]
The name of the certificate provider.
string
The Lambda function ARN that's associated with the certificate provider.
list
A list of the operations that the certificate provider will use to generate certificates. Valid value: CreateCertificateFromCsr .
(string) --
dict
Response Syntax
{
'certificateProviderName': 'string',
'certificateProviderArn': 'string'
}
Response Structure
(dict) --
certificateProviderName (string) --
The name of the certificate provider.
certificateProviderArn (string) --
The ARN of the certificate provider.
Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
See also: AWS API Documentation
Request Syntax
client.describe_certificate_provider(
certificateProviderName='string'
)
string
[REQUIRED]
The name of the certificate provider.
dict
Response Syntax
{
'certificateProviderName': 'string',
'certificateProviderArn': 'string',
'lambdaFunctionArn': 'string',
'accountDefaultForOperations': [
'CreateCertificateFromCsr',
],
'creationDate': datetime(2015, 1, 1),
'lastModifiedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
certificateProviderName (string) --
The name of the certificate provider.
certificateProviderArn (string) --
The ARN of the certificate provider.
lambdaFunctionArn (string) --
The Lambda function ARN that's associated with the certificate provider.
accountDefaultForOperations (list) --
A list of the operations that the certificate provider will use to generate certificates. Valid value: CreateCertificateFromCsr .
(string) --
creationDate (datetime) --
The date-time string that indicates when the certificate provider was created.
lastModifiedDate (datetime) --
The date-time string that indicates when the certificate provider was last updated.
Deletes a certificate provider.
Requires permission to access the DeleteCertificateProvider action.
If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).
See also: AWS API Documentation
Request Syntax
client.delete_certificate_provider(
certificateProviderName='string'
)
string
[REQUIRED]
The name of the certificate provider.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists all your certificate providers in your Amazon Web Services account.
Requires permission to access the ListCertificateProviders action.
See also: AWS API Documentation
Request Syntax
client.list_certificate_providers(
nextToken='string',
ascendingOrder=True|False
)
string
The token for the next set of results, or null if there are no more results.
boolean
Returns the list of certificate providers in ascending alphabetical order.
dict
Response Syntax
{
'certificateProviders': [
{
'certificateProviderName': 'string',
'certificateProviderArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
certificateProviders (list) --
The list of certificate providers in your Amazon Web Services account.
(dict) --
The certificate provider summary.
certificateProviderName (string) --
The name of the certificate provider.
certificateProviderArn (string) --
The ARN of the certificate provider.
nextToken (string) --
The token for the next set of results, or null if there are no more results.