acmpca

package
v1.13.43 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package acmpca provides the client and types for making API requests to AWS Certificate Manager Private Certificate Authority.

You can use the ACM PCA API to create a private certificate authority (CA). You must first call the CreateCertificateAuthority function. If successful, the function returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the GetCertificateAuthorityCsr function to retrieve the certificate signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your on-premises PKI hierarchy, and call the ImportCertificateAuthorityCertificate to import your signed private CA certificate into ACM PCA.

Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization. Call the IssueCertificate function to issue a certificate. Call the RevokeCertificate function to revoke a certificate.

Certificates issued by your private CA can be trusted only within your organization, not publicly.

Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To create a CRL, you must specify a RevocationConfiguration object when you call the CreateCertificateAuthority function. ACM PCA writes the CRL to an S3 bucket that you specify. You must specify a bucket policy that grants ACM PCA write permission.

You can also call the CreateCertificateAuthorityAuditReport to create an optional audit report that lists every time the CA private key is used. The private key is used for signing when the IssueCertificate or RevokeCertificate function is called.

See https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22 for more information on this service.

See acmpca package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/acmpca/

Using the Client

To contact AWS Certificate Manager Private Certificate Authority with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Certificate Manager Private Certificate Authority client ACMPCA for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/acmpca/#New

Index

Constants

View Source
const (
	// AuditReportResponseFormatJson is a AuditReportResponseFormat enum value
	AuditReportResponseFormatJson = "JSON"

	// AuditReportResponseFormatCsv is a AuditReportResponseFormat enum value
	AuditReportResponseFormatCsv = "CSV"
)
View Source
const (
	// AuditReportStatusCreating is a AuditReportStatus enum value
	AuditReportStatusCreating = "CREATING"

	// AuditReportStatusSuccess is a AuditReportStatus enum value
	AuditReportStatusSuccess = "SUCCESS"

	// AuditReportStatusFailed is a AuditReportStatus enum value
	AuditReportStatusFailed = "FAILED"
)
View Source
const (
	// CertificateAuthorityStatusCreating is a CertificateAuthorityStatus enum value
	CertificateAuthorityStatusCreating = "CREATING"

	// CertificateAuthorityStatusPendingCertificate is a CertificateAuthorityStatus enum value
	CertificateAuthorityStatusPendingCertificate = "PENDING_CERTIFICATE"

	// CertificateAuthorityStatusActive is a CertificateAuthorityStatus enum value
	CertificateAuthorityStatusActive = "ACTIVE"

	// CertificateAuthorityStatusDisabled is a CertificateAuthorityStatus enum value
	CertificateAuthorityStatusDisabled = "DISABLED"

	// CertificateAuthorityStatusExpired is a CertificateAuthorityStatus enum value
	CertificateAuthorityStatusExpired = "EXPIRED"

	// CertificateAuthorityStatusFailed is a CertificateAuthorityStatus enum value
	CertificateAuthorityStatusFailed = "FAILED"
)
View Source
const (
	// FailureReasonRequestTimedOut is a FailureReason enum value
	FailureReasonRequestTimedOut = "REQUEST_TIMED_OUT"

	// FailureReasonUnsupportedAlgorithm is a FailureReason enum value
	FailureReasonUnsupportedAlgorithm = "UNSUPPORTED_ALGORITHM"

	// FailureReasonOther is a FailureReason enum value
	FailureReasonOther = "OTHER"
)
View Source
const (
	// KeyAlgorithmRsa2048 is a KeyAlgorithm enum value
	KeyAlgorithmRsa2048 = "RSA_2048"

	// KeyAlgorithmRsa4096 is a KeyAlgorithm enum value
	KeyAlgorithmRsa4096 = "RSA_4096"

	// KeyAlgorithmEcPrime256v1 is a KeyAlgorithm enum value
	KeyAlgorithmEcPrime256v1 = "EC_prime256v1"

	// KeyAlgorithmEcSecp384r1 is a KeyAlgorithm enum value
	KeyAlgorithmEcSecp384r1 = "EC_secp384r1"
)
View Source
const (
	// RevocationReasonUnspecified is a RevocationReason enum value
	RevocationReasonUnspecified = "UNSPECIFIED"

	// RevocationReasonKeyCompromise is a RevocationReason enum value
	RevocationReasonKeyCompromise = "KEY_COMPROMISE"

	// RevocationReasonCertificateAuthorityCompromise is a RevocationReason enum value
	RevocationReasonCertificateAuthorityCompromise = "CERTIFICATE_AUTHORITY_COMPROMISE"

	// RevocationReasonAffiliationChanged is a RevocationReason enum value
	RevocationReasonAffiliationChanged = "AFFILIATION_CHANGED"

	// RevocationReasonSuperseded is a RevocationReason enum value
	RevocationReasonSuperseded = "SUPERSEDED"

	// RevocationReasonCessationOfOperation is a RevocationReason enum value
	RevocationReasonCessationOfOperation = "CESSATION_OF_OPERATION"

	// RevocationReasonPrivilegeWithdrawn is a RevocationReason enum value
	RevocationReasonPrivilegeWithdrawn = "PRIVILEGE_WITHDRAWN"

	// RevocationReasonAACompromise is a RevocationReason enum value
	RevocationReasonAACompromise = "A_A_COMPROMISE"
)
View Source
const (
	// SigningAlgorithmSha256withecdsa is a SigningAlgorithm enum value
	SigningAlgorithmSha256withecdsa = "SHA256WITHECDSA"

	// SigningAlgorithmSha384withecdsa is a SigningAlgorithm enum value
	SigningAlgorithmSha384withecdsa = "SHA384WITHECDSA"

	// SigningAlgorithmSha512withecdsa is a SigningAlgorithm enum value
	SigningAlgorithmSha512withecdsa = "SHA512WITHECDSA"

	// SigningAlgorithmSha256withrsa is a SigningAlgorithm enum value
	SigningAlgorithmSha256withrsa = "SHA256WITHRSA"

	// SigningAlgorithmSha384withrsa is a SigningAlgorithm enum value
	SigningAlgorithmSha384withrsa = "SHA384WITHRSA"

	// SigningAlgorithmSha512withrsa is a SigningAlgorithm enum value
	SigningAlgorithmSha512withrsa = "SHA512WITHRSA"
)
View Source
const (
	// ValidityPeriodTypeEndDate is a ValidityPeriodType enum value
	ValidityPeriodTypeEndDate = "END_DATE"

	// ValidityPeriodTypeAbsolute is a ValidityPeriodType enum value
	ValidityPeriodTypeAbsolute = "ABSOLUTE"

	// ValidityPeriodTypeDays is a ValidityPeriodType enum value
	ValidityPeriodTypeDays = "DAYS"

	// ValidityPeriodTypeMonths is a ValidityPeriodType enum value
	ValidityPeriodTypeMonths = "MONTHS"

	// ValidityPeriodTypeYears is a ValidityPeriodType enum value
	ValidityPeriodTypeYears = "YEARS"
)
View Source
const (

	// ErrCodeCertificateMismatchException for service response error code
	// "CertificateMismatchException".
	//
	// The certificate authority certificate you are importing does not comply with
	// conditions specified in the certificate that signed it.
	ErrCodeCertificateMismatchException = "CertificateMismatchException"

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// A previous update to your private CA is still ongoing.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeInvalidArgsException for service response error code
	// "InvalidArgsException".
	//
	// One or more of the specified arguments was not valid.
	ErrCodeInvalidArgsException = "InvalidArgsException"

	// ErrCodeInvalidArnException for service response error code
	// "InvalidArnException".
	//
	// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
	ErrCodeInvalidArnException = "InvalidArnException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The token specified in the NextToken argument is not valid. Use the token
	// returned from your previous call to ListCertificateAuthorities.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidPolicyException for service response error code
	// "InvalidPolicyException".
	//
	// The S3 bucket policy is not valid. The policy must give ACM PCA rights to
	// read from and write to the bucket and find the bucket location.
	ErrCodeInvalidPolicyException = "InvalidPolicyException"

	// ErrCodeInvalidStateException for service response error code
	// "InvalidStateException".
	//
	// The private CA is in a state during which a report cannot be generated.
	ErrCodeInvalidStateException = "InvalidStateException"

	// ErrCodeInvalidTagException for service response error code
	// "InvalidTagException".
	//
	// The tag associated with the CA is not valid. The invalid argument is contained
	// in the message field.
	ErrCodeInvalidTagException = "InvalidTagException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// An ACM PCA limit has been exceeded. See the exception message returned to
	// determine the limit that was exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMalformedCSRException for service response error code
	// "MalformedCSRException".
	//
	// The certificate signing request is invalid.
	ErrCodeMalformedCSRException = "MalformedCSRException"

	// ErrCodeMalformedCertificateException for service response error code
	// "MalformedCertificateException".
	//
	// One or more fields in the certificate are invalid.
	ErrCodeMalformedCertificateException = "MalformedCertificateException"

	// ErrCodeRequestAlreadyProcessedException for service response error code
	// "RequestAlreadyProcessedException".
	//
	// Your request has already been completed.
	ErrCodeRequestAlreadyProcessedException = "RequestAlreadyProcessedException"

	// ErrCodeRequestFailedException for service response error code
	// "RequestFailedException".
	//
	// The request has failed for an unspecified reason.
	ErrCodeRequestFailedException = "RequestFailedException"

	// ErrCodeRequestInProgressException for service response error code
	// "RequestInProgressException".
	//
	// Your request is already in progress.
	ErrCodeRequestInProgressException = "RequestInProgressException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource such as a private CA, S3 bucket, certificate, or audit report
	// cannot be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// You can associate up to 50 tags with a private CA. Exception information
	// is contained in the exception message field.
	ErrCodeTooManyTagsException = "TooManyTagsException"
)
View Source
const (
	ServiceName = "acm-pca"   // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

View Source
const (
	// CertificateAuthorityTypeSubordinate is a CertificateAuthorityType enum value
	CertificateAuthorityTypeSubordinate = "SUBORDINATE"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ACMPCA

type ACMPCA struct {
	*client.Client
}

ACMPCA provides the API operation methods for making requests to AWS Certificate Manager Private Certificate Authority. See this package's package overview docs for details on the service.

ACMPCA methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ACMPCA

New creates a new instance of the ACMPCA client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a ACMPCA client from just a session.
svc := acmpca.New(mySession)

// Create a ACMPCA client with additional configuration
svc := acmpca.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ACMPCA) CreateCertificateAuthority

func (c *ACMPCA) CreateCertificateAuthority(input *CreateCertificateAuthorityInput) (*CreateCertificateAuthorityOutput, error)

CreateCertificateAuthority API operation for AWS Certificate Manager Private Certificate Authority.

Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this function returns the Amazon Resource Name (ARN) of the CA.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation CreateCertificateAuthority for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgsException "InvalidArgsException" One or more of the specified arguments was not valid.

  • ErrCodeInvalidPolicyException "InvalidPolicyException" The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.

  • ErrCodeLimitExceededException "LimitExceededException" An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority

func (*ACMPCA) CreateCertificateAuthorityAuditReport

func (c *ACMPCA) CreateCertificateAuthorityAuditReport(input *CreateCertificateAuthorityAuditReportInput) (*CreateCertificateAuthorityAuditReportOutput, error)

CreateCertificateAuthorityAuditReport API operation for AWS Certificate Manager Private Certificate Authority.

Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate functions use the private key. You can generate a new report every 30 minutes.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation CreateCertificateAuthorityAuditReport for usage and error information.

Returned Error Codes:

  • ErrCodeRequestInProgressException "RequestInProgressException" Your request is already in progress.

  • ErrCodeRequestFailedException "RequestFailedException" The request has failed for an unspecified reason.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeInvalidArgsException "InvalidArgsException" One or more of the specified arguments was not valid.

  • ErrCodeInvalidStateException "InvalidStateException" The private CA is in a state during which a report cannot be generated.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport

func (*ACMPCA) CreateCertificateAuthorityAuditReportRequest

func (c *ACMPCA) CreateCertificateAuthorityAuditReportRequest(input *CreateCertificateAuthorityAuditReportInput) (req *request.Request, output *CreateCertificateAuthorityAuditReportOutput)

CreateCertificateAuthorityAuditReportRequest generates a "aws/request.Request" representing the client's request for the CreateCertificateAuthorityAuditReport operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCertificateAuthorityAuditReport for more information on using the CreateCertificateAuthorityAuditReport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCertificateAuthorityAuditReportRequest method.
req, resp := client.CreateCertificateAuthorityAuditReportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport

func (*ACMPCA) CreateCertificateAuthorityAuditReportWithContext

func (c *ACMPCA) CreateCertificateAuthorityAuditReportWithContext(ctx aws.Context, input *CreateCertificateAuthorityAuditReportInput, opts ...request.Option) (*CreateCertificateAuthorityAuditReportOutput, error)

CreateCertificateAuthorityAuditReportWithContext is the same as CreateCertificateAuthorityAuditReport with the addition of the ability to pass a context and additional request options.

See CreateCertificateAuthorityAuditReport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) CreateCertificateAuthorityRequest

func (c *ACMPCA) CreateCertificateAuthorityRequest(input *CreateCertificateAuthorityInput) (req *request.Request, output *CreateCertificateAuthorityOutput)

CreateCertificateAuthorityRequest generates a "aws/request.Request" representing the client's request for the CreateCertificateAuthority operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCertificateAuthority for more information on using the CreateCertificateAuthority API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCertificateAuthorityRequest method.
req, resp := client.CreateCertificateAuthorityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority

func (*ACMPCA) CreateCertificateAuthorityWithContext

func (c *ACMPCA) CreateCertificateAuthorityWithContext(ctx aws.Context, input *CreateCertificateAuthorityInput, opts ...request.Option) (*CreateCertificateAuthorityOutput, error)

CreateCertificateAuthorityWithContext is the same as CreateCertificateAuthority with the addition of the ability to pass a context and additional request options.

See CreateCertificateAuthority for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) DeleteCertificateAuthority

func (c *ACMPCA) DeleteCertificateAuthority(input *DeleteCertificateAuthorityInput) (*DeleteCertificateAuthorityOutput, error)

DeleteCertificateAuthority API operation for AWS Certificate Manager Private Certificate Authority.

Deletes the private certificate authority (CA) that you created or started to create by calling the CreateCertificateAuthority function. This action requires that you enter an ARN (Amazon Resource Name) for the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities function. You can delete the CA if you are waiting for it to be created (the Status field of the CertificateAuthority is CREATING) or if the CA has been created but you haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE) into ACM PCA. If you've already imported the certificate, you cannot delete the CA unless it has been disabled for more than 30 days. To disable a CA, call the UpdateCertificateAuthority function and set the CertificateAuthorityStatus argument to DISABLED.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation DeleteCertificateAuthority for usage and error information.

Returned Error Codes:

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" A previous update to your private CA is still ongoing.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeInvalidStateException "InvalidStateException" The private CA is in a state during which a report cannot be generated.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority

func (*ACMPCA) DeleteCertificateAuthorityRequest

func (c *ACMPCA) DeleteCertificateAuthorityRequest(input *DeleteCertificateAuthorityInput) (req *request.Request, output *DeleteCertificateAuthorityOutput)

DeleteCertificateAuthorityRequest generates a "aws/request.Request" representing the client's request for the DeleteCertificateAuthority operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCertificateAuthority for more information on using the DeleteCertificateAuthority API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCertificateAuthorityRequest method.
req, resp := client.DeleteCertificateAuthorityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority

func (*ACMPCA) DeleteCertificateAuthorityWithContext

func (c *ACMPCA) DeleteCertificateAuthorityWithContext(ctx aws.Context, input *DeleteCertificateAuthorityInput, opts ...request.Option) (*DeleteCertificateAuthorityOutput, error)

DeleteCertificateAuthorityWithContext is the same as DeleteCertificateAuthority with the addition of the ability to pass a context and additional request options.

See DeleteCertificateAuthority for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) DescribeCertificateAuthority

func (c *ACMPCA) DescribeCertificateAuthority(input *DescribeCertificateAuthorityInput) (*DescribeCertificateAuthorityOutput, error)

DescribeCertificateAuthority API operation for AWS Certificate Manager Private Certificate Authority.

Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

  • CREATING: ACM PCA is creating your private certificate authority.

  • PENDING_CERTIFICATE: The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

  • ACTIVE: Your private CA is active.

  • DISABLED: Your private CA has been disabled.

  • EXPIRED: Your private CA certificate has expired.

  • FAILED: Your private CA has failed. Your CA can fail for problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation DescribeCertificateAuthority for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority

func (*ACMPCA) DescribeCertificateAuthorityAuditReport

func (c *ACMPCA) DescribeCertificateAuthorityAuditReport(input *DescribeCertificateAuthorityAuditReportInput) (*DescribeCertificateAuthorityAuditReportOutput, error)

DescribeCertificateAuthorityAuditReport API operation for AWS Certificate Manager Private Certificate Authority.

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport function. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate function or the RevokeCertificate function.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation DescribeCertificateAuthorityAuditReport for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArgsException "InvalidArgsException" One or more of the specified arguments was not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport

func (*ACMPCA) DescribeCertificateAuthorityAuditReportRequest

func (c *ACMPCA) DescribeCertificateAuthorityAuditReportRequest(input *DescribeCertificateAuthorityAuditReportInput) (req *request.Request, output *DescribeCertificateAuthorityAuditReportOutput)

DescribeCertificateAuthorityAuditReportRequest generates a "aws/request.Request" representing the client's request for the DescribeCertificateAuthorityAuditReport operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCertificateAuthorityAuditReport for more information on using the DescribeCertificateAuthorityAuditReport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCertificateAuthorityAuditReportRequest method.
req, resp := client.DescribeCertificateAuthorityAuditReportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport

func (*ACMPCA) DescribeCertificateAuthorityAuditReportWithContext

func (c *ACMPCA) DescribeCertificateAuthorityAuditReportWithContext(ctx aws.Context, input *DescribeCertificateAuthorityAuditReportInput, opts ...request.Option) (*DescribeCertificateAuthorityAuditReportOutput, error)

DescribeCertificateAuthorityAuditReportWithContext is the same as DescribeCertificateAuthorityAuditReport with the addition of the ability to pass a context and additional request options.

See DescribeCertificateAuthorityAuditReport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) DescribeCertificateAuthorityRequest

func (c *ACMPCA) DescribeCertificateAuthorityRequest(input *DescribeCertificateAuthorityInput) (req *request.Request, output *DescribeCertificateAuthorityOutput)

DescribeCertificateAuthorityRequest generates a "aws/request.Request" representing the client's request for the DescribeCertificateAuthority operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCertificateAuthority for more information on using the DescribeCertificateAuthority API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCertificateAuthorityRequest method.
req, resp := client.DescribeCertificateAuthorityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority

func (*ACMPCA) DescribeCertificateAuthorityWithContext

func (c *ACMPCA) DescribeCertificateAuthorityWithContext(ctx aws.Context, input *DescribeCertificateAuthorityInput, opts ...request.Option) (*DescribeCertificateAuthorityOutput, error)

DescribeCertificateAuthorityWithContext is the same as DescribeCertificateAuthority with the addition of the ability to pass a context and additional request options.

See DescribeCertificateAuthority for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) GetCertificate

func (c *ACMPCA) GetCertificate(input *GetCertificateInput) (*GetCertificateOutput, error)

GetCertificate API operation for AWS Certificate Manager Private Certificate Authority.

Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate function. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate function. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport function to create a report that contains information about all of the certificates issued and revoked by your private CA.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation GetCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeRequestInProgressException "RequestInProgressException" Your request is already in progress.

  • ErrCodeRequestFailedException "RequestFailedException" The request has failed for an unspecified reason.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeInvalidStateException "InvalidStateException" The private CA is in a state during which a report cannot be generated.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate

func (*ACMPCA) GetCertificateAuthorityCertificate

func (c *ACMPCA) GetCertificateAuthorityCertificate(input *GetCertificateAuthorityCertificateInput) (*GetCertificateAuthorityCertificateOutput, error)

GetCertificateAuthorityCertificate API operation for AWS Certificate Manager Private Certificate Authority.

Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation GetCertificateAuthorityCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidStateException "InvalidStateException" The private CA is in a state during which a report cannot be generated.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate

func (*ACMPCA) GetCertificateAuthorityCertificateRequest

func (c *ACMPCA) GetCertificateAuthorityCertificateRequest(input *GetCertificateAuthorityCertificateInput) (req *request.Request, output *GetCertificateAuthorityCertificateOutput)

GetCertificateAuthorityCertificateRequest generates a "aws/request.Request" representing the client's request for the GetCertificateAuthorityCertificate operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCertificateAuthorityCertificate for more information on using the GetCertificateAuthorityCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCertificateAuthorityCertificateRequest method.
req, resp := client.GetCertificateAuthorityCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate

func (*ACMPCA) GetCertificateAuthorityCertificateWithContext

func (c *ACMPCA) GetCertificateAuthorityCertificateWithContext(ctx aws.Context, input *GetCertificateAuthorityCertificateInput, opts ...request.Option) (*GetCertificateAuthorityCertificateOutput, error)

GetCertificateAuthorityCertificateWithContext is the same as GetCertificateAuthorityCertificate with the addition of the ability to pass a context and additional request options.

See GetCertificateAuthorityCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) GetCertificateAuthorityCsr

func (c *ACMPCA) GetCertificateAuthorityCsr(input *GetCertificateAuthorityCsrInput) (*GetCertificateAuthorityCsrOutput, error)

GetCertificateAuthorityCsr API operation for AWS Certificate Manager Private Certificate Authority.

Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority function. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the ImportCertificateAuthorityCertificate function. The CSR is returned as a base64 PEM-encoded string.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation GetCertificateAuthorityCsr for usage and error information.

Returned Error Codes:

  • ErrCodeRequestInProgressException "RequestInProgressException" Your request is already in progress.

  • ErrCodeRequestFailedException "RequestFailedException" The request has failed for an unspecified reason.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr

func (*ACMPCA) GetCertificateAuthorityCsrRequest

func (c *ACMPCA) GetCertificateAuthorityCsrRequest(input *GetCertificateAuthorityCsrInput) (req *request.Request, output *GetCertificateAuthorityCsrOutput)

GetCertificateAuthorityCsrRequest generates a "aws/request.Request" representing the client's request for the GetCertificateAuthorityCsr operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCertificateAuthorityCsr for more information on using the GetCertificateAuthorityCsr API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCertificateAuthorityCsrRequest method.
req, resp := client.GetCertificateAuthorityCsrRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr

func (*ACMPCA) GetCertificateAuthorityCsrWithContext

func (c *ACMPCA) GetCertificateAuthorityCsrWithContext(ctx aws.Context, input *GetCertificateAuthorityCsrInput, opts ...request.Option) (*GetCertificateAuthorityCsrOutput, error)

GetCertificateAuthorityCsrWithContext is the same as GetCertificateAuthorityCsr with the addition of the ability to pass a context and additional request options.

See GetCertificateAuthorityCsr for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) GetCertificateRequest

func (c *ACMPCA) GetCertificateRequest(input *GetCertificateInput) (req *request.Request, output *GetCertificateOutput)

GetCertificateRequest generates a "aws/request.Request" representing the client's request for the GetCertificate operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCertificate for more information on using the GetCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCertificateRequest method.
req, resp := client.GetCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate

func (*ACMPCA) GetCertificateWithContext

func (c *ACMPCA) GetCertificateWithContext(ctx aws.Context, input *GetCertificateInput, opts ...request.Option) (*GetCertificateOutput, error)

GetCertificateWithContext is the same as GetCertificate with the addition of the ability to pass a context and additional request options.

See GetCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) ImportCertificateAuthorityCertificate

func (c *ACMPCA) ImportCertificateAuthorityCertificate(input *ImportCertificateAuthorityCertificateInput) (*ImportCertificateAuthorityCertificateOutput, error)

ImportCertificateAuthorityCertificate API operation for AWS Certificate Manager Private Certificate Authority.

Imports your signed private CA certificate into ACM PCA. Before you can call this function, you must create the private certificate authority by calling the CreateCertificateAuthority function. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr function. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

Your certificate chain must not include the private CA certificate that you are importing.

Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.

The chain must be PEM-encoded.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation ImportCertificateAuthorityCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" A previous update to your private CA is still ongoing.

  • ErrCodeRequestInProgressException "RequestInProgressException" Your request is already in progress.

  • ErrCodeRequestFailedException "RequestFailedException" The request has failed for an unspecified reason.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeMalformedCertificateException "MalformedCertificateException" One or more fields in the certificate are invalid.

  • ErrCodeCertificateMismatchException "CertificateMismatchException" The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate

func (*ACMPCA) ImportCertificateAuthorityCertificateRequest

func (c *ACMPCA) ImportCertificateAuthorityCertificateRequest(input *ImportCertificateAuthorityCertificateInput) (req *request.Request, output *ImportCertificateAuthorityCertificateOutput)

ImportCertificateAuthorityCertificateRequest generates a "aws/request.Request" representing the client's request for the ImportCertificateAuthorityCertificate operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportCertificateAuthorityCertificate for more information on using the ImportCertificateAuthorityCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ImportCertificateAuthorityCertificateRequest method.
req, resp := client.ImportCertificateAuthorityCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate

func (*ACMPCA) ImportCertificateAuthorityCertificateWithContext

func (c *ACMPCA) ImportCertificateAuthorityCertificateWithContext(ctx aws.Context, input *ImportCertificateAuthorityCertificateInput, opts ...request.Option) (*ImportCertificateAuthorityCertificateOutput, error)

ImportCertificateAuthorityCertificateWithContext is the same as ImportCertificateAuthorityCertificate with the addition of the ability to pass a context and additional request options.

See ImportCertificateAuthorityCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) IssueCertificate

func (c *ACMPCA) IssueCertificate(input *IssueCertificateInput) (*IssueCertificateOutput, error)

IssueCertificate API operation for AWS Certificate Manager Private Certificate Authority.

Uses your private certificate authority (CA) to issue a client certificate. This function returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate function and specifying the ARN.

You cannot use the ACM ListCertificateAuthorities function to retrieve the ARNs of the certificates that you issue by using ACM PCA.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation IssueCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededException "LimitExceededException" An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidStateException "InvalidStateException" The private CA is in a state during which a report cannot be generated.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeInvalidArgsException "InvalidArgsException" One or more of the specified arguments was not valid.

  • ErrCodeMalformedCSRException "MalformedCSRException" The certificate signing request is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate

func (*ACMPCA) IssueCertificateRequest

func (c *ACMPCA) IssueCertificateRequest(input *IssueCertificateInput) (req *request.Request, output *IssueCertificateOutput)

IssueCertificateRequest generates a "aws/request.Request" representing the client's request for the IssueCertificate operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IssueCertificate for more information on using the IssueCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the IssueCertificateRequest method.
req, resp := client.IssueCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate

func (*ACMPCA) IssueCertificateWithContext

func (c *ACMPCA) IssueCertificateWithContext(ctx aws.Context, input *IssueCertificateInput, opts ...request.Option) (*IssueCertificateOutput, error)

IssueCertificateWithContext is the same as IssueCertificate with the addition of the ability to pass a context and additional request options.

See IssueCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) ListCertificateAuthorities

func (c *ACMPCA) ListCertificateAuthorities(input *ListCertificateAuthoritiesInput) (*ListCertificateAuthoritiesOutput, error)

ListCertificateAuthorities API operation for AWS Certificate Manager Private Certificate Authority.

Lists the private certificate authorities that you created by using the CreateCertificateAuthority function.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation ListCertificateAuthorities for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities

func (*ACMPCA) ListCertificateAuthoritiesRequest

func (c *ACMPCA) ListCertificateAuthoritiesRequest(input *ListCertificateAuthoritiesInput) (req *request.Request, output *ListCertificateAuthoritiesOutput)

ListCertificateAuthoritiesRequest generates a "aws/request.Request" representing the client's request for the ListCertificateAuthorities operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCertificateAuthorities for more information on using the ListCertificateAuthorities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListCertificateAuthoritiesRequest method.
req, resp := client.ListCertificateAuthoritiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities

func (*ACMPCA) ListCertificateAuthoritiesWithContext

func (c *ACMPCA) ListCertificateAuthoritiesWithContext(ctx aws.Context, input *ListCertificateAuthoritiesInput, opts ...request.Option) (*ListCertificateAuthoritiesOutput, error)

ListCertificateAuthoritiesWithContext is the same as ListCertificateAuthorities with the addition of the ability to pass a context and additional request options.

See ListCertificateAuthorities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) ListTags

func (c *ACMPCA) ListTags(input *ListTagsInput) (*ListTagsOutput, error)

ListTags API operation for AWS Certificate Manager Private Certificate Authority.

Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority function to add one or more tags to your CA. Call the UntagCertificateAuthority function to remove tags.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation ListTags for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags

func (*ACMPCA) ListTagsRequest

func (c *ACMPCA) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)

ListTagsRequest generates a "aws/request.Request" representing the client's request for the ListTags operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTags for more information on using the ListTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsRequest method.
req, resp := client.ListTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags

func (*ACMPCA) ListTagsWithContext

func (c *ACMPCA) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)

ListTagsWithContext is the same as ListTags with the addition of the ability to pass a context and additional request options.

See ListTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) RevokeCertificate

func (c *ACMPCA) RevokeCertificate(input *RevokeCertificateInput) (*RevokeCertificateOutput, error)

RevokeCertificate API operation for AWS Certificate Manager Private Certificate Authority.

Revokes a certificate that you issued by calling the IssueCertificate function. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation RevokeCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" A previous update to your private CA is still ongoing.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeInvalidStateException "InvalidStateException" The private CA is in a state during which a report cannot be generated.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeRequestAlreadyProcessedException "RequestAlreadyProcessedException" Your request has already been completed.

  • ErrCodeRequestInProgressException "RequestInProgressException" Your request is already in progress.

  • ErrCodeRequestFailedException "RequestFailedException" The request has failed for an unspecified reason.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate

func (*ACMPCA) RevokeCertificateRequest

func (c *ACMPCA) RevokeCertificateRequest(input *RevokeCertificateInput) (req *request.Request, output *RevokeCertificateOutput)

RevokeCertificateRequest generates a "aws/request.Request" representing the client's request for the RevokeCertificate operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RevokeCertificate for more information on using the RevokeCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RevokeCertificateRequest method.
req, resp := client.RevokeCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate

func (*ACMPCA) RevokeCertificateWithContext

func (c *ACMPCA) RevokeCertificateWithContext(ctx aws.Context, input *RevokeCertificateInput, opts ...request.Option) (*RevokeCertificateOutput, error)

RevokeCertificateWithContext is the same as RevokeCertificate with the addition of the ability to pass a context and additional request options.

See RevokeCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) TagCertificateAuthority

func (c *ACMPCA) TagCertificateAuthority(input *TagCertificateAuthorityInput) (*TagCertificateAuthorityOutput, error)

TagCertificateAuthority API operation for AWS Certificate Manager Private Certificate Authority.

Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority function. Call the ListTags function to see what tags are associated with your CA.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation TagCertificateAuthority for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeInvalidTagException "InvalidTagException" The tag associated with the CA is not valid. The invalid argument is contained in the message field.

  • ErrCodeTooManyTagsException "TooManyTagsException" You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority

func (*ACMPCA) TagCertificateAuthorityRequest

func (c *ACMPCA) TagCertificateAuthorityRequest(input *TagCertificateAuthorityInput) (req *request.Request, output *TagCertificateAuthorityOutput)

TagCertificateAuthorityRequest generates a "aws/request.Request" representing the client's request for the TagCertificateAuthority operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagCertificateAuthority for more information on using the TagCertificateAuthority API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagCertificateAuthorityRequest method.
req, resp := client.TagCertificateAuthorityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority

func (*ACMPCA) TagCertificateAuthorityWithContext

func (c *ACMPCA) TagCertificateAuthorityWithContext(ctx aws.Context, input *TagCertificateAuthorityInput, opts ...request.Option) (*TagCertificateAuthorityOutput, error)

TagCertificateAuthorityWithContext is the same as TagCertificateAuthority with the addition of the ability to pass a context and additional request options.

See TagCertificateAuthority for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) UntagCertificateAuthority

func (c *ACMPCA) UntagCertificateAuthority(input *UntagCertificateAuthorityInput) (*UntagCertificateAuthorityOutput, error)

UntagCertificateAuthority API operation for AWS Certificate Manager Private Certificate Authority.

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags function to see what tags are associated with your CA.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation UntagCertificateAuthority for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeInvalidTagException "InvalidTagException" The tag associated with the CA is not valid. The invalid argument is contained in the message field.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority

func (*ACMPCA) UntagCertificateAuthorityRequest

func (c *ACMPCA) UntagCertificateAuthorityRequest(input *UntagCertificateAuthorityInput) (req *request.Request, output *UntagCertificateAuthorityOutput)

UntagCertificateAuthorityRequest generates a "aws/request.Request" representing the client's request for the UntagCertificateAuthority operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagCertificateAuthority for more information on using the UntagCertificateAuthority API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagCertificateAuthorityRequest method.
req, resp := client.UntagCertificateAuthorityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority

func (*ACMPCA) UntagCertificateAuthorityWithContext

func (c *ACMPCA) UntagCertificateAuthorityWithContext(ctx aws.Context, input *UntagCertificateAuthorityInput, opts ...request.Option) (*UntagCertificateAuthorityOutput, error)

UntagCertificateAuthorityWithContext is the same as UntagCertificateAuthority with the addition of the ability to pass a context and additional request options.

See UntagCertificateAuthority for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ACMPCA) UpdateCertificateAuthority

func (c *ACMPCA) UpdateCertificateAuthority(input *UpdateCertificateAuthorityInput) (*UpdateCertificateAuthorityOutput, error)

UpdateCertificateAuthority API operation for AWS Certificate Manager Private Certificate Authority.

Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's API operation UpdateCertificateAuthority for usage and error information.

Returned Error Codes:

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" A previous update to your private CA is still ongoing.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

  • ErrCodeInvalidArgsException "InvalidArgsException" One or more of the specified arguments was not valid.

  • ErrCodeInvalidArnException "InvalidArnException" The requested Amazon Resource Name (ARN) does not refer to an existing resource.

  • ErrCodeInvalidStateException "InvalidStateException" The private CA is in a state during which a report cannot be generated.

  • ErrCodeInvalidPolicyException "InvalidPolicyException" The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority

func (*ACMPCA) UpdateCertificateAuthorityRequest

func (c *ACMPCA) UpdateCertificateAuthorityRequest(input *UpdateCertificateAuthorityInput) (req *request.Request, output *UpdateCertificateAuthorityOutput)

UpdateCertificateAuthorityRequest generates a "aws/request.Request" representing the client's request for the UpdateCertificateAuthority operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateCertificateAuthority for more information on using the UpdateCertificateAuthority API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateCertificateAuthorityRequest method.
req, resp := client.UpdateCertificateAuthorityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority

func (*ACMPCA) UpdateCertificateAuthorityWithContext

func (c *ACMPCA) UpdateCertificateAuthorityWithContext(ctx aws.Context, input *UpdateCertificateAuthorityInput, opts ...request.Option) (*UpdateCertificateAuthorityOutput, error)

UpdateCertificateAuthorityWithContext is the same as UpdateCertificateAuthority with the addition of the ability to pass a context and additional request options.

See UpdateCertificateAuthority for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ASN1Subject

type ASN1Subject struct {

	// Fully qualified domain name (FQDN) associated with the certificate subject.
	CommonName *string `type:"string"`

	// Two digit code that specifies the country in which the certificate subject
	// located.
	Country *string `type:"string"`

	// Disambiguating information for the certificate subject.
	DistinguishedNameQualifier *string `type:"string"`

	// Typically a qualifier appended to the name of an individual. Examples include
	// Jr. for junior, Sr. for senior, and III for third.
	GenerationQualifier *string `type:"string"`

	// First name.
	GivenName *string `type:"string"`

	// Concatenation that typically contains the first letter of the GivenName,
	// the first letter of the middle name if one exists, and the first letter of
	// the SurName.
	Initials *string `type:"string"`

	// The locality (such as a city or town) in which the certificate subject is
	// located.
	Locality *string `type:"string"`

	// Legal name of the organization with which the certificate subject is affiliated.
	Organization *string `type:"string"`

	// A subdivision or unit of the organization (such as sales or finance) with
	// which the certificate subject is affiliated.
	OrganizationalUnit *string `type:"string"`

	// Typically a shortened version of a longer GivenName. For example, Jonathan
	// is often shortened to John. Elizabeth is often shortened to Beth, Liz, or
	// Eliza.
	Pseudonym *string `type:"string"`

	// The certificate serial number.
	SerialNumber *string `type:"string"`

	// State in which the subject of the certificate is located.
	State *string `type:"string"`

	// Family name. In the US and the UK for example, the surname of an individual
	// is ordered last. In Asian cultures the surname is typically ordered first.
	Surname *string `type:"string"`

	// A title such as Mr. or Ms. which is pre-pended to the name to refer formally
	// to the certificate subject.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.

func (ASN1Subject) GoString

func (s ASN1Subject) GoString() string

GoString returns the string representation

func (*ASN1Subject) SetCommonName

func (s *ASN1Subject) SetCommonName(v string) *ASN1Subject

SetCommonName sets the CommonName field's value.

func (*ASN1Subject) SetCountry

func (s *ASN1Subject) SetCountry(v string) *ASN1Subject

SetCountry sets the Country field's value.

func (*ASN1Subject) SetDistinguishedNameQualifier

func (s *ASN1Subject) SetDistinguishedNameQualifier(v string) *ASN1Subject

SetDistinguishedNameQualifier sets the DistinguishedNameQualifier field's value.

func (*ASN1Subject) SetGenerationQualifier

func (s *ASN1Subject) SetGenerationQualifier(v string) *ASN1Subject

SetGenerationQualifier sets the GenerationQualifier field's value.

func (*ASN1Subject) SetGivenName

func (s *ASN1Subject) SetGivenName(v string) *ASN1Subject

SetGivenName sets the GivenName field's value.

func (*ASN1Subject) SetInitials

func (s *ASN1Subject) SetInitials(v string) *ASN1Subject

SetInitials sets the Initials field's value.

func (*ASN1Subject) SetLocality

func (s *ASN1Subject) SetLocality(v string) *ASN1Subject

SetLocality sets the Locality field's value.

func (*ASN1Subject) SetOrganization

func (s *ASN1Subject) SetOrganization(v string) *ASN1Subject

SetOrganization sets the Organization field's value.

func (*ASN1Subject) SetOrganizationalUnit

func (s *ASN1Subject) SetOrganizationalUnit(v string) *ASN1Subject

SetOrganizationalUnit sets the OrganizationalUnit field's value.

func (*ASN1Subject) SetPseudonym

func (s *ASN1Subject) SetPseudonym(v string) *ASN1Subject

SetPseudonym sets the Pseudonym field's value.

func (*ASN1Subject) SetSerialNumber

func (s *ASN1Subject) SetSerialNumber(v string) *ASN1Subject

SetSerialNumber sets the SerialNumber field's value.

func (*ASN1Subject) SetState

func (s *ASN1Subject) SetState(v string) *ASN1Subject

SetState sets the State field's value.

func (*ASN1Subject) SetSurname

func (s *ASN1Subject) SetSurname(v string) *ASN1Subject

SetSurname sets the Surname field's value.

func (*ASN1Subject) SetTitle

func (s *ASN1Subject) SetTitle(v string) *ASN1Subject

SetTitle sets the Title field's value.

func (ASN1Subject) String

func (s ASN1Subject) String() string

String returns the string representation

type CertificateAuthority

type CertificateAuthority struct {

	// Amazon Resource Name (ARN) for your private certificate authority (CA). The
	// format is 12345678-1234-1234-1234-123456789012.
	Arn *string `min:"5" type:"string"`

	// Your private CA configuration.
	CertificateAuthorityConfiguration *CertificateAuthorityConfiguration `type:"structure"`

	// Date and time at which your private CA was created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Reason the request to create your private CA failed.
	FailureReason *string `type:"string" enum:"FailureReason"`

	// Date and time at which your private CA was last updated.
	LastStateChangeAt *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Date and time after which your private CA certificate is not valid.
	NotAfter *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Date and time before which your private CA certificate is not valid.
	NotBefore *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Information about the certificate revocation list (CRL) created and maintained
	// by your private CA.
	RevocationConfiguration *RevocationConfiguration `type:"structure"`

	// Serial number of your private CA.
	Serial *string `type:"string"`

	// Status of your private CA.
	Status *string `type:"string" enum:"CertificateAuthorityStatus"`

	// Type of your private CA.
	Type *string `type:"string" enum:"CertificateAuthorityType"`
	// contains filtered or unexported fields
}

Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority function to create your private CA. You must then call the GetCertificateAuthorityCertificate function to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the ImportCertificateAuthorityCertificate function to import the signed certificate into AWS Certificate Manager (ACM).

func (CertificateAuthority) GoString

func (s CertificateAuthority) GoString() string

GoString returns the string representation

func (*CertificateAuthority) SetArn

SetArn sets the Arn field's value.

func (*CertificateAuthority) SetCertificateAuthorityConfiguration

func (s *CertificateAuthority) SetCertificateAuthorityConfiguration(v *CertificateAuthorityConfiguration) *CertificateAuthority

SetCertificateAuthorityConfiguration sets the CertificateAuthorityConfiguration field's value.

func (*CertificateAuthority) SetCreatedAt

func (s *CertificateAuthority) SetCreatedAt(v time.Time) *CertificateAuthority

SetCreatedAt sets the CreatedAt field's value.

func (*CertificateAuthority) SetFailureReason

func (s *CertificateAuthority) SetFailureReason(v string) *CertificateAuthority

SetFailureReason sets the FailureReason field's value.

func (*CertificateAuthority) SetLastStateChangeAt

func (s *CertificateAuthority) SetLastStateChangeAt(v time.Time) *CertificateAuthority

SetLastStateChangeAt sets the LastStateChangeAt field's value.

func (*CertificateAuthority) SetNotAfter

SetNotAfter sets the NotAfter field's value.

func (*CertificateAuthority) SetNotBefore

func (s *CertificateAuthority) SetNotBefore(v time.Time) *CertificateAuthority

SetNotBefore sets the NotBefore field's value.

func (*CertificateAuthority) SetRevocationConfiguration

func (s *CertificateAuthority) SetRevocationConfiguration(v *RevocationConfiguration) *CertificateAuthority

SetRevocationConfiguration sets the RevocationConfiguration field's value.

func (*CertificateAuthority) SetSerial

SetSerial sets the Serial field's value.

func (*CertificateAuthority) SetStatus

SetStatus sets the Status field's value.

func (*CertificateAuthority) SetType

SetType sets the Type field's value.

func (CertificateAuthority) String

func (s CertificateAuthority) String() string

String returns the string representation

type CertificateAuthorityConfiguration

type CertificateAuthorityConfiguration struct {

	// Type of the public key algorithm and size, in bits, of the key pair that
	// your key pair creates when it issues a certificate.
	//
	// KeyAlgorithm is a required field
	KeyAlgorithm *string `type:"string" required:"true" enum:"KeyAlgorithm"`

	// Name of the algorithm your private CA uses to sign certificate requests.
	//
	// SigningAlgorithm is a required field
	SigningAlgorithm *string `type:"string" required:"true" enum:"SigningAlgorithm"`

	// Structure that contains X.500 distinguished name information for your private
	// CA.
	//
	// Subject is a required field
	Subject *ASN1Subject `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority function.

func (CertificateAuthorityConfiguration) GoString

GoString returns the string representation

func (*CertificateAuthorityConfiguration) SetKeyAlgorithm

SetKeyAlgorithm sets the KeyAlgorithm field's value.

func (*CertificateAuthorityConfiguration) SetSigningAlgorithm

SetSigningAlgorithm sets the SigningAlgorithm field's value.

func (*CertificateAuthorityConfiguration) SetSubject

SetSubject sets the Subject field's value.

func (CertificateAuthorityConfiguration) String

String returns the string representation

func (*CertificateAuthorityConfiguration) Validate

Validate inspects the fields of the type to determine if they are valid.

type CreateCertificateAuthorityAuditReportInput

type CreateCertificateAuthorityAuditReportInput struct {

	// Format in which to create the report. This can be either JSON or CSV.
	//
	// AuditReportResponseFormat is a required field
	AuditReportResponseFormat *string `type:"string" required:"true" enum:"AuditReportResponseFormat"`

	// Amazon Resource Name (ARN) of the CA to be audited. This is of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012.
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// Name of the S3 bucket that will contain the audit report.
	//
	// S3BucketName is a required field
	S3BucketName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCertificateAuthorityAuditReportInput) GoString

GoString returns the string representation

func (*CreateCertificateAuthorityAuditReportInput) SetAuditReportResponseFormat

SetAuditReportResponseFormat sets the AuditReportResponseFormat field's value.

func (*CreateCertificateAuthorityAuditReportInput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*CreateCertificateAuthorityAuditReportInput) SetS3BucketName

SetS3BucketName sets the S3BucketName field's value.

func (CreateCertificateAuthorityAuditReportInput) String

String returns the string representation

func (*CreateCertificateAuthorityAuditReportInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type CreateCertificateAuthorityAuditReportOutput

type CreateCertificateAuthorityAuditReportOutput struct {

	// An alphanumeric string that contains a report identifier.
	AuditReportId *string `min:"36" type:"string"`

	// The key that uniquely identifies the report file in your S3 bucket.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateCertificateAuthorityAuditReportOutput) GoString

GoString returns the string representation

func (*CreateCertificateAuthorityAuditReportOutput) SetAuditReportId

SetAuditReportId sets the AuditReportId field's value.

func (*CreateCertificateAuthorityAuditReportOutput) SetS3Key

SetS3Key sets the S3Key field's value.

func (CreateCertificateAuthorityAuditReportOutput) String

String returns the string representation

type CreateCertificateAuthorityInput

type CreateCertificateAuthorityInput struct {

	// Name and bit size of the private key algorithm, the name of the signing algorithm,
	// and X.500 certificate subject information.
	//
	// CertificateAuthorityConfiguration is a required field
	CertificateAuthorityConfiguration *CertificateAuthorityConfiguration `type:"structure" required:"true"`

	// The type of the certificate authority. Currently, this must be SUBORDINATE.
	//
	// CertificateAuthorityType is a required field
	CertificateAuthorityType *string `type:"string" required:"true" enum:"CertificateAuthorityType"`

	// Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority.
	// Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority
	// multiple times with the same idempotency token within a five minute period,
	// ACM PCA recognizes that you are requesting only one certificate and will
	// issue only one. If you change the idempotency token for each call, however,
	// ACM PCA recognizes that you are requesting multiple certificates.
	IdempotencyToken *string `min:"1" type:"string"`

	// Contains a Boolean value that you can use to enable a certification revocation
	// list (CRL) for the CA, the name of the S3 bucket to which ACM PCA will write
	// the CRL, and an optional CNAME alias that you can use to hide the name of
	// your bucket in the CRL Distribution Points extension of your CA certificate.
	// For more information, see the CrlConfiguration structure.
	RevocationConfiguration *RevocationConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCertificateAuthorityInput) GoString

GoString returns the string representation

func (*CreateCertificateAuthorityInput) SetCertificateAuthorityConfiguration

SetCertificateAuthorityConfiguration sets the CertificateAuthorityConfiguration field's value.

func (*CreateCertificateAuthorityInput) SetCertificateAuthorityType

func (s *CreateCertificateAuthorityInput) SetCertificateAuthorityType(v string) *CreateCertificateAuthorityInput

SetCertificateAuthorityType sets the CertificateAuthorityType field's value.

func (*CreateCertificateAuthorityInput) SetIdempotencyToken

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateCertificateAuthorityInput) SetRevocationConfiguration

SetRevocationConfiguration sets the RevocationConfiguration field's value.

func (CreateCertificateAuthorityInput) String

String returns the string representation

func (*CreateCertificateAuthorityInput) Validate

func (s *CreateCertificateAuthorityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCertificateAuthorityOutput

type CreateCertificateAuthorityOutput struct {

	// If successful, the Amazon Resource Name (ARN) of the certificate authority
	// (CA). This is of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012.
	CertificateAuthorityArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (CreateCertificateAuthorityOutput) GoString

GoString returns the string representation

func (*CreateCertificateAuthorityOutput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (CreateCertificateAuthorityOutput) String

String returns the string representation

type CrlConfiguration

type CrlConfiguration struct {

	// Name inserted into the certificate CRL Distribution Points extension that
	// enables the use of an alias for the CRL distribution point. Use this value
	// if you don't want the name of your S3 bucket to be public.
	CustomCname *string `type:"string"`

	// Boolean value that specifies whether certificate revocation lists (CRLs)
	// are enabled. You can use this value to enable certificate revocation for
	// a new CA when you call the CreateCertificateAuthority function or for an
	// existing CA when you call the UpdateCertificateAuthority function.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`

	// Number of days until a certificate expires.
	ExpirationInDays *int64 `min:"1" type:"integer"`

	// Name of the S3 bucket that contains the CRL. If you do not provide a value
	// for the CustomCname argument, the name of your S3 bucket is placed into the
	// CRL Distribution Points extension of the issued certificate. You can change
	// the name of your bucket by calling the UpdateCertificateAuthority function.
	// You must specify a bucket policy that allows ACM PCA to write the CRL to
	// your bucket.
	S3BucketName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA.

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.

CRLs contain the following fields:

  • Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.

  • Signature Algorithm: The name of the algorithm used to sign the CRL.

  • Issuer: The X.500 distinguished name of your private CA that issued the CRL.

  • Last Update: The issue date and time of this CRL.

  • Next Update: The day and time by which the next CRL will be issued.

  • Revoked Certificates: List of revoked certificates. Each list item contains the following information.

Serial Number: The serial number, in hexadecimal format, of the revoked certificate.

Revocation Date: Date and time the certificate was revoked.

CRL Entry Extensions: Optional extensions for the CRL entry.

X509v3 CRL Reason Code: Reason the certificate was revoked.

  • CRL Extensions: Optional extensions for the CRL.

X509v3 Authority Key Identifier: Identifies the public key associated with

the private key used to sign the certificate.

X509v3 CRL Number:: Decimal sequence number for the CRL.

  • Signature Algorithm: Algorithm used by your private CA to sign the CRL.

  • Signature Value: Signature computed over the CRL.

Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in crl_path -noout

func (CrlConfiguration) GoString

func (s CrlConfiguration) GoString() string

GoString returns the string representation

func (*CrlConfiguration) SetCustomCname

func (s *CrlConfiguration) SetCustomCname(v string) *CrlConfiguration

SetCustomCname sets the CustomCname field's value.

func (*CrlConfiguration) SetEnabled

func (s *CrlConfiguration) SetEnabled(v bool) *CrlConfiguration

SetEnabled sets the Enabled field's value.

func (*CrlConfiguration) SetExpirationInDays

func (s *CrlConfiguration) SetExpirationInDays(v int64) *CrlConfiguration

SetExpirationInDays sets the ExpirationInDays field's value.

func (*CrlConfiguration) SetS3BucketName

func (s *CrlConfiguration) SetS3BucketName(v string) *CrlConfiguration

SetS3BucketName sets the S3BucketName field's value.

func (CrlConfiguration) String

func (s CrlConfiguration) String() string

String returns the string representation

func (*CrlConfiguration) Validate

func (s *CrlConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCertificateAuthorityInput

type DeleteCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012.
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCertificateAuthorityInput) GoString

GoString returns the string representation

func (*DeleteCertificateAuthorityInput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (DeleteCertificateAuthorityInput) String

String returns the string representation

func (*DeleteCertificateAuthorityInput) Validate

func (s *DeleteCertificateAuthorityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCertificateAuthorityOutput

type DeleteCertificateAuthorityOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCertificateAuthorityOutput) GoString

GoString returns the string representation

func (DeleteCertificateAuthorityOutput) String

String returns the string representation

type DescribeCertificateAuthorityAuditReportInput

type DescribeCertificateAuthorityAuditReportInput struct {

	// The report ID returned by calling the CreateCertificateAuthorityAuditReport
	// function.
	//
	// AuditReportId is a required field
	AuditReportId *string `min:"36" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the private CA. This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012.
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCertificateAuthorityAuditReportInput) GoString

GoString returns the string representation

func (*DescribeCertificateAuthorityAuditReportInput) SetAuditReportId

SetAuditReportId sets the AuditReportId field's value.

func (*DescribeCertificateAuthorityAuditReportInput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (DescribeCertificateAuthorityAuditReportInput) String

String returns the string representation

func (*DescribeCertificateAuthorityAuditReportInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeCertificateAuthorityAuditReportOutput

type DescribeCertificateAuthorityAuditReportOutput struct {

	// Specifies whether report creation is in progress, has succeeded, or has failed.
	AuditReportStatus *string `type:"string" enum:"AuditReportStatus"`

	// The date and time at which the report was created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Name of the S3 bucket that contains the report.
	S3BucketName *string `type:"string"`

	// S3 key that uniquely identifies the report file in your S3 bucket.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCertificateAuthorityAuditReportOutput) GoString

GoString returns the string representation

func (*DescribeCertificateAuthorityAuditReportOutput) SetAuditReportStatus

SetAuditReportStatus sets the AuditReportStatus field's value.

func (*DescribeCertificateAuthorityAuditReportOutput) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeCertificateAuthorityAuditReportOutput) SetS3BucketName

SetS3BucketName sets the S3BucketName field's value.

func (*DescribeCertificateAuthorityAuditReportOutput) SetS3Key

SetS3Key sets the S3Key field's value.

func (DescribeCertificateAuthorityAuditReportOutput) String

String returns the string representation

type DescribeCertificateAuthorityInput

type DescribeCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012.
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCertificateAuthorityInput) GoString

GoString returns the string representation

func (*DescribeCertificateAuthorityInput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (DescribeCertificateAuthorityInput) String

String returns the string representation

func (*DescribeCertificateAuthorityInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeCertificateAuthorityOutput

type DescribeCertificateAuthorityOutput struct {

	// A CertificateAuthority structure that contains information about your private
	// CA.
	CertificateAuthority *CertificateAuthority `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeCertificateAuthorityOutput) GoString

GoString returns the string representation

func (*DescribeCertificateAuthorityOutput) SetCertificateAuthority

SetCertificateAuthority sets the CertificateAuthority field's value.

func (DescribeCertificateAuthorityOutput) String

String returns the string representation

type GetCertificateAuthorityCertificateInput

type GetCertificateAuthorityCertificateInput struct {

	// The Amazon Resource Name (ARN) of your private CA. This is of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012.
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCertificateAuthorityCertificateInput) GoString

GoString returns the string representation

func (*GetCertificateAuthorityCertificateInput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (GetCertificateAuthorityCertificateInput) String

String returns the string representation

func (*GetCertificateAuthorityCertificateInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetCertificateAuthorityCertificateOutput

type GetCertificateAuthorityCertificateOutput struct {

	// Base64-encoded certificate authority (CA) certificate.
	Certificate *string `type:"string"`

	// Base64-encoded certificate chain that includes any intermediate certificates
	// and chains up to root on-premises certificate that you used to sign your
	// private CA certificate. The chain does not include your private CA certificate.
	CertificateChain *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCertificateAuthorityCertificateOutput) GoString

GoString returns the string representation

func (*GetCertificateAuthorityCertificateOutput) SetCertificate

SetCertificate sets the Certificate field's value.

func (*GetCertificateAuthorityCertificateOutput) SetCertificateChain

SetCertificateChain sets the CertificateChain field's value.

func (GetCertificateAuthorityCertificateOutput) String

String returns the string representation

type GetCertificateAuthorityCsrInput

type GetCertificateAuthorityCsrInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority
	// function. This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCertificateAuthorityCsrInput) GoString

GoString returns the string representation

func (*GetCertificateAuthorityCsrInput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (GetCertificateAuthorityCsrInput) String

String returns the string representation

func (*GetCertificateAuthorityCsrInput) Validate

func (s *GetCertificateAuthorityCsrInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCertificateAuthorityCsrOutput

type GetCertificateAuthorityCsrOutput struct {

	// The base64 PEM-encoded certificate signing request (CSR) for your private
	// CA certificate.
	Csr *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCertificateAuthorityCsrOutput) GoString

GoString returns the string representation

func (*GetCertificateAuthorityCsrOutput) SetCsr

SetCsr sets the Csr field's value.

func (GetCertificateAuthorityCsrOutput) String

String returns the string representation

type GetCertificateInput

type GetCertificateInput struct {

	// The ARN of the issued certificate. The ARN contains the certificate serial
	// number and must be in the following form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
	//
	// CertificateArn is a required field
	CertificateArn *string `min:"5" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012.
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCertificateInput) GoString

func (s GetCertificateInput) GoString() string

GoString returns the string representation

func (*GetCertificateInput) SetCertificateArn

func (s *GetCertificateInput) SetCertificateArn(v string) *GetCertificateInput

SetCertificateArn sets the CertificateArn field's value.

func (*GetCertificateInput) SetCertificateAuthorityArn

func (s *GetCertificateInput) SetCertificateAuthorityArn(v string) *GetCertificateInput

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (GetCertificateInput) String

func (s GetCertificateInput) String() string

String returns the string representation

func (*GetCertificateInput) Validate

func (s *GetCertificateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCertificateOutput

type GetCertificateOutput struct {

	// The base64 PEM-encoded certificate specified by the CertificateArn parameter.
	Certificate *string `type:"string"`

	// The base64 PEM-encoded certificate chain that chains up to the on-premises
	// root CA certificate that you used to sign your private CA certificate.
	CertificateChain *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCertificateOutput) GoString

func (s GetCertificateOutput) GoString() string

GoString returns the string representation

func (*GetCertificateOutput) SetCertificate

func (s *GetCertificateOutput) SetCertificate(v string) *GetCertificateOutput

SetCertificate sets the Certificate field's value.

func (*GetCertificateOutput) SetCertificateChain

func (s *GetCertificateOutput) SetCertificateChain(v string) *GetCertificateOutput

SetCertificateChain sets the CertificateChain field's value.

func (GetCertificateOutput) String

func (s GetCertificateOutput) String() string

String returns the string representation

type ImportCertificateAuthorityCertificateInput

type ImportCertificateAuthorityCertificateInput struct {

	// The PEM-encoded certificate for your private CA. This must be signed by using
	// your on-premises CA.
	//
	// Certificate is automatically base64 encoded/decoded by the SDK.
	//
	// Certificate is a required field
	Certificate []byte `min:"1" type:"blob" required:"true"`

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// A PEM-encoded file that contains all of your certificates, other than the
	// certificate you're importing, chaining up to your root CA. Your on-premises
	// root certificate is the last in the chain, and each certificate in the chain
	// signs the one preceding.
	//
	// CertificateChain is automatically base64 encoded/decoded by the SDK.
	//
	// CertificateChain is a required field
	CertificateChain []byte `type:"blob" required:"true"`
	// contains filtered or unexported fields
}

func (ImportCertificateAuthorityCertificateInput) GoString

GoString returns the string representation

func (*ImportCertificateAuthorityCertificateInput) SetCertificate

SetCertificate sets the Certificate field's value.

func (*ImportCertificateAuthorityCertificateInput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*ImportCertificateAuthorityCertificateInput) SetCertificateChain

SetCertificateChain sets the CertificateChain field's value.

func (ImportCertificateAuthorityCertificateInput) String

String returns the string representation

func (*ImportCertificateAuthorityCertificateInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ImportCertificateAuthorityCertificateOutput

type ImportCertificateAuthorityCertificateOutput struct {
	// contains filtered or unexported fields
}

func (ImportCertificateAuthorityCertificateOutput) GoString

GoString returns the string representation

func (ImportCertificateAuthorityCertificateOutput) String

String returns the string representation

type IssueCertificateInput

type IssueCertificateInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// The certificate signing request (CSR) for the certificate you want to issue.
	// You can use the following OpenSSL command to create the CSR and a 2048 bit
	// RSA private key.
	//
	// openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem
	// -out csr/test_cert_.csr
	//
	// If you have a configuration file, you can use the following OpenSSL command.
	// The usr_cert block in the configuration file contains your X509 version 3
	// extensions.
	//
	// openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048
	// -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
	//
	// Csr is automatically base64 encoded/decoded by the SDK.
	//
	// Csr is a required field
	Csr []byte `min:"1" type:"blob" required:"true"`

	// Custom string that can be used to distinguish between calls to the IssueCertificate
	// function. Idempotency tokens time out after one hour. Therefore, if you call
	// IssueCertificate multiple times with the same idempotency token within 5
	// minutes, ACM PCA recognizes that you are requesting only one certificate
	// and will issue only one. If you change the idempotency token for each call,
	// PCA recognizes that you are requesting multiple certificates.
	IdempotencyToken *string `min:"1" type:"string"`

	// The name of the algorithm that will be used to sign the certificate to be
	// issued.
	//
	// SigningAlgorithm is a required field
	SigningAlgorithm *string `type:"string" required:"true" enum:"SigningAlgorithm"`

	// The type of the validity period.
	//
	// Validity is a required field
	Validity *Validity `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (IssueCertificateInput) GoString

func (s IssueCertificateInput) GoString() string

GoString returns the string representation

func (*IssueCertificateInput) SetCertificateAuthorityArn

func (s *IssueCertificateInput) SetCertificateAuthorityArn(v string) *IssueCertificateInput

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*IssueCertificateInput) SetCsr

SetCsr sets the Csr field's value.

func (*IssueCertificateInput) SetIdempotencyToken

func (s *IssueCertificateInput) SetIdempotencyToken(v string) *IssueCertificateInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*IssueCertificateInput) SetSigningAlgorithm

func (s *IssueCertificateInput) SetSigningAlgorithm(v string) *IssueCertificateInput

SetSigningAlgorithm sets the SigningAlgorithm field's value.

func (*IssueCertificateInput) SetValidity

SetValidity sets the Validity field's value.

func (IssueCertificateInput) String

func (s IssueCertificateInput) String() string

String returns the string representation

func (*IssueCertificateInput) Validate

func (s *IssueCertificateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IssueCertificateOutput

type IssueCertificateOutput struct {

	// The Amazon Resource Name (ARN) of the issued certificate and the certificate
	// serial number. This is of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
	CertificateArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (IssueCertificateOutput) GoString

func (s IssueCertificateOutput) GoString() string

GoString returns the string representation

func (*IssueCertificateOutput) SetCertificateArn

func (s *IssueCertificateOutput) SetCertificateArn(v string) *IssueCertificateOutput

SetCertificateArn sets the CertificateArn field's value.

func (IssueCertificateOutput) String

func (s IssueCertificateOutput) String() string

String returns the string representation

type ListCertificateAuthoritiesInput

type ListCertificateAuthoritiesInput struct {

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListCertificateAuthoritiesInput) GoString

GoString returns the string representation

func (*ListCertificateAuthoritiesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListCertificateAuthoritiesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListCertificateAuthoritiesInput) String

String returns the string representation

func (*ListCertificateAuthoritiesInput) Validate

func (s *ListCertificateAuthoritiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCertificateAuthoritiesOutput

type ListCertificateAuthoritiesOutput struct {

	// Summary information about each certificate authority you have created.
	CertificateAuthorities []*CertificateAuthority `type:"list"`

	// When the list is truncated, this value is present and should be used for
	// the NextToken parameter in a subsequent pagination request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListCertificateAuthoritiesOutput) GoString

GoString returns the string representation

func (*ListCertificateAuthoritiesOutput) SetCertificateAuthorities

SetCertificateAuthorities sets the CertificateAuthorities field's value.

func (*ListCertificateAuthoritiesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListCertificateAuthoritiesOutput) String

String returns the string representation

type ListTagsInput

type ListTagsInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority
	// function. This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// Use this parameter when paginating results to specify the maximum number
	// of items to return in the response. 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// Use this parameter when paginating results in a subsequent request after
	// you receive a response with truncated results. Set it to the value of NextToken
	// from the response you just received.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTagsInput) GoString

func (s ListTagsInput) GoString() string

GoString returns the string representation

func (*ListTagsInput) SetCertificateAuthorityArn

func (s *ListTagsInput) SetCertificateAuthorityArn(v string) *ListTagsInput

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*ListTagsInput) SetMaxResults

func (s *ListTagsInput) SetMaxResults(v int64) *ListTagsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsInput) SetNextToken

func (s *ListTagsInput) SetNextToken(v string) *ListTagsInput

SetNextToken sets the NextToken field's value.

func (ListTagsInput) String

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate

func (s *ListTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsOutput

type ListTagsOutput struct {

	// When the list is truncated, this value is present and should be used for
	// the NextToken parameter in a subsequent pagination request.
	NextToken *string `min:"1" type:"string"`

	// The tags associated with your private CA.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsOutput) GoString

func (s ListTagsOutput) GoString() string

GoString returns the string representation

func (*ListTagsOutput) SetNextToken

func (s *ListTagsOutput) SetNextToken(v string) *ListTagsOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsOutput) SetTags

func (s *ListTagsOutput) SetTags(v []*Tag) *ListTagsOutput

SetTags sets the Tags field's value.

func (ListTagsOutput) String

func (s ListTagsOutput) String() string

String returns the string representation

type RevocationConfiguration

type RevocationConfiguration struct {

	// Configuration of the certificate revocation list (CRL), if any, maintained
	// by your private CA.
	CrlConfiguration *CrlConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority functions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate.

func (RevocationConfiguration) GoString

func (s RevocationConfiguration) GoString() string

GoString returns the string representation

func (*RevocationConfiguration) SetCrlConfiguration

SetCrlConfiguration sets the CrlConfiguration field's value.

func (RevocationConfiguration) String

func (s RevocationConfiguration) String() string

String returns the string representation

func (*RevocationConfiguration) Validate

func (s *RevocationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RevokeCertificateInput

type RevokeCertificateInput struct {

	// Amazon Resource Name (ARN) of the private CA that issued the certificate
	// to be revoked. This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// Serial number of the certificate to be revoked. This must be in hexadecimal
	// format. You can retrieve the serial number by calling GetCertificate with
	// the Amazon Resource Name (ARN) of the certificate you want and the ARN of
	// your private CA. The GetCertificate function retrieves the certificate in
	// the PEM format. You can use the following OpenSSL command to list the certificate
	// in text format and copy the hexadecimal serial number.
	//
	// openssl x509 -in file_path -text -noout
	//
	// You can also copy the serial number from the console or use the DescribeCertificate
	// (http://docs.aws.amazon.comacm/latest/APIReferenceAPI_DescribeCertificate.html)
	// function in the AWS Certificate Manager API Reference.
	//
	// CertificateSerial is a required field
	CertificateSerial *string `type:"string" required:"true"`

	// Specifies why you revoked the certificate.
	//
	// RevocationReason is a required field
	RevocationReason *string `type:"string" required:"true" enum:"RevocationReason"`
	// contains filtered or unexported fields
}

func (RevokeCertificateInput) GoString

func (s RevokeCertificateInput) GoString() string

GoString returns the string representation

func (*RevokeCertificateInput) SetCertificateAuthorityArn

func (s *RevokeCertificateInput) SetCertificateAuthorityArn(v string) *RevokeCertificateInput

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*RevokeCertificateInput) SetCertificateSerial

func (s *RevokeCertificateInput) SetCertificateSerial(v string) *RevokeCertificateInput

SetCertificateSerial sets the CertificateSerial field's value.

func (*RevokeCertificateInput) SetRevocationReason

func (s *RevokeCertificateInput) SetRevocationReason(v string) *RevokeCertificateInput

SetRevocationReason sets the RevocationReason field's value.

func (RevokeCertificateInput) String

func (s RevokeCertificateInput) String() string

String returns the string representation

func (*RevokeCertificateInput) Validate

func (s *RevokeCertificateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RevokeCertificateOutput

type RevokeCertificateOutput struct {
	// contains filtered or unexported fields
}

func (RevokeCertificateOutput) GoString

func (s RevokeCertificateOutput) GoString() string

GoString returns the string representation

func (RevokeCertificateOutput) String

func (s RevokeCertificateOutput) String() string

String returns the string representation

type Tag

type Tag struct {

	// Key (name) of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Value of the tag.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority function. To remove a tag, call the UntagCertificateAuthority function.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagCertificateAuthorityInput

type TagCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// List of tags to be associated with the CA.
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagCertificateAuthorityInput) GoString

func (s TagCertificateAuthorityInput) GoString() string

GoString returns the string representation

func (*TagCertificateAuthorityInput) SetCertificateAuthorityArn

func (s *TagCertificateAuthorityInput) SetCertificateAuthorityArn(v string) *TagCertificateAuthorityInput

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*TagCertificateAuthorityInput) SetTags

SetTags sets the Tags field's value.

func (TagCertificateAuthorityInput) String

String returns the string representation

func (*TagCertificateAuthorityInput) Validate

func (s *TagCertificateAuthorityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagCertificateAuthorityOutput

type TagCertificateAuthorityOutput struct {
	// contains filtered or unexported fields
}

func (TagCertificateAuthorityOutput) GoString

GoString returns the string representation

func (TagCertificateAuthorityOutput) String

String returns the string representation

type UntagCertificateAuthorityInput

type UntagCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// List of tags to be removed from the CA.
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagCertificateAuthorityInput) GoString

GoString returns the string representation

func (*UntagCertificateAuthorityInput) SetCertificateAuthorityArn

func (s *UntagCertificateAuthorityInput) SetCertificateAuthorityArn(v string) *UntagCertificateAuthorityInput

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*UntagCertificateAuthorityInput) SetTags

SetTags sets the Tags field's value.

func (UntagCertificateAuthorityInput) String

String returns the string representation

func (*UntagCertificateAuthorityInput) Validate

func (s *UntagCertificateAuthorityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagCertificateAuthorityOutput

type UntagCertificateAuthorityOutput struct {
	// contains filtered or unexported fields
}

func (UntagCertificateAuthorityOutput) GoString

GoString returns the string representation

func (UntagCertificateAuthorityOutput) String

String returns the string representation

type UpdateCertificateAuthorityInput

type UpdateCertificateAuthorityInput struct {

	// Amazon Resource Name (ARN) of the private CA that issued the certificate
	// to be revoked. This must be of the form:
	//
	// arn:aws:acm:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// Revocation information for your private CA.
	RevocationConfiguration *RevocationConfiguration `type:"structure"`

	// Status of your private CA.
	Status *string `type:"string" enum:"CertificateAuthorityStatus"`
	// contains filtered or unexported fields
}

func (UpdateCertificateAuthorityInput) GoString

GoString returns the string representation

func (*UpdateCertificateAuthorityInput) SetCertificateAuthorityArn

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*UpdateCertificateAuthorityInput) SetRevocationConfiguration

SetRevocationConfiguration sets the RevocationConfiguration field's value.

func (*UpdateCertificateAuthorityInput) SetStatus

SetStatus sets the Status field's value.

func (UpdateCertificateAuthorityInput) String

String returns the string representation

func (*UpdateCertificateAuthorityInput) Validate

func (s *UpdateCertificateAuthorityInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateCertificateAuthorityOutput

type UpdateCertificateAuthorityOutput struct {
	// contains filtered or unexported fields
}

func (UpdateCertificateAuthorityOutput) GoString

GoString returns the string representation

func (UpdateCertificateAuthorityOutput) String

String returns the string representation

type Validity

type Validity struct {

	// Specifies whether the Value parameter represents days, months, or years.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ValidityPeriodType"`

	// Time period.
	//
	// Value is a required field
	Value *int64 `min:"1" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the IssueCertificate function.

func (Validity) GoString

func (s Validity) GoString() string

GoString returns the string representation

func (*Validity) SetType

func (s *Validity) SetType(v string) *Validity

SetType sets the Type field's value.

func (*Validity) SetValue

func (s *Validity) SetValue(v int64) *Validity

SetValue sets the Value field's value.

func (Validity) String

func (s Validity) String() string

String returns the string representation

func (*Validity) Validate

func (s *Validity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Directories

Path Synopsis
Package acmpcaiface provides an interface to enable mocking the AWS Certificate Manager Private Certificate Authority service client for testing your code.
Package acmpcaiface provides an interface to enable mocking the AWS Certificate Manager Private Certificate Authority service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL