AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ACM

import "github.com/aws/aws-sdk-go/service/acm"

type ACM struct { *client.Client }

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

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

Client

Type: *client.Client

Method

AddTagsToCertificate

func (c *ACM) AddTagsToCertificate(input *AddTagsToCertificateInput) (*AddTagsToCertificateOutput, error)

AddTagsToCertificate API operation for AWS Certificate Manager.

Adds one or more tags to an ACM certificate. 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 certificate 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 certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates (https://docs.aws.amazon.com/acm/latest/userguide/tags.html).

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

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's API operation AddTagsToCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

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

  • ErrCodeInvalidTagException "InvalidTagException" One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

  • ErrCodeTooManyTagsException "TooManyTagsException" The request contains too many tags. Try the request again with fewer tags.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/AddTagsToCertificate

AddTagsToCertificateRequest

func (c *ACM) AddTagsToCertificateRequest(input *AddTagsToCertificateInput) (req *request.Request, output *AddTagsToCertificateOutput)

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

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 AddTagsToCertificate for more information on using the AddTagsToCertificate 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 AddTagsToCertificateRequest method. req, resp := client.AddTagsToCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/AddTagsToCertificate

AddTagsToCertificateWithContext

func (c *ACM) AddTagsToCertificateWithContext(ctx aws.Context, input *AddTagsToCertificateInput, opts ...request.Option) (*AddTagsToCertificateOutput, error)

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

See AddTagsToCertificate 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.

See Also

For more information about using this API, see AWS API Documentation.

DeleteCertificate

func (c *ACM) DeleteCertificate(input *DeleteCertificateInput) (*DeleteCertificateOutput, error)

DeleteCertificate API operation for AWS Certificate Manager.

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.

You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

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's API operation DeleteCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

  • ErrCodeResourceInUseException "ResourceInUseException" The certificate is in use by another AWS service in the caller's account. Remove the association and try again.

  • 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-2015-12-08/DeleteCertificate

DeleteCertificateRequest

func (c *ACM) DeleteCertificateRequest(input *DeleteCertificateInput) (req *request.Request, output *DeleteCertificateOutput)

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

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 DeleteCertificate for more information on using the DeleteCertificate 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 DeleteCertificateRequest method. req, resp := client.DeleteCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/DeleteCertificate

DeleteCertificateWithContext

func (c *ACM) DeleteCertificateWithContext(ctx aws.Context, input *DeleteCertificateInput, opts ...request.Option) (*DeleteCertificateOutput, error)

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

See DeleteCertificate 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.

See Also

For more information about using this API, see AWS API Documentation.

DescribeCertificate

func (c *ACM) DescribeCertificate(input *DescribeCertificateInput) (*DescribeCertificateOutput, error)

DescribeCertificate API operation for AWS Certificate Manager.

Returns detailed metadata about the specified ACM certificate.

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's API operation DescribeCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account 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-2015-12-08/DescribeCertificate

DescribeCertificateRequest

func (c *ACM) DescribeCertificateRequest(input *DescribeCertificateInput) (req *request.Request, output *DescribeCertificateOutput)

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

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 DescribeCertificate for more information on using the DescribeCertificate 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 DescribeCertificateRequest method. req, resp := client.DescribeCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/DescribeCertificate

DescribeCertificateWithContext

func (c *ACM) DescribeCertificateWithContext(ctx aws.Context, input *DescribeCertificateInput, opts ...request.Option) (*DescribeCertificateOutput, error)

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

See DescribeCertificate 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.

See Also

For more information about using this API, see AWS API Documentation.

ExportCertificate

func (c *ACM) ExportCertificate(input *ExportCertificateInput) (*ExportCertificateOutput, error)

ExportCertificate API operation for AWS Certificate Manager.

Exports a private certificate issued by a private certificate authority (CA) for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted.

openssl rsa -in encrypted_key.pem -out decrypted_key.pem

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's API operation ExportCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

  • ErrCodeRequestInProgressException "RequestInProgressException" The certificate request is in process and the certificate in your account has not yet been issued.

  • 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-2015-12-08/ExportCertificate

ExportCertificateRequest

func (c *ACM) ExportCertificateRequest(input *ExportCertificateInput) (req *request.Request, output *ExportCertificateOutput)

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

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 ExportCertificate for more information on using the ExportCertificate 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 ExportCertificateRequest method. req, resp := client.ExportCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/ExportCertificate

ExportCertificateWithContext

func (c *ACM) ExportCertificateWithContext(ctx aws.Context, input *ExportCertificateInput, opts ...request.Option) (*ExportCertificateOutput, error)

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

See ExportCertificate 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.

See Also

For more information about using this API, see AWS API Documentation.

GetCertificate

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

GetCertificate API operation for AWS Certificate Manager.

Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.

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's API operation GetCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

  • ErrCodeRequestInProgressException "RequestInProgressException" The certificate request is in process and the certificate in your account has not yet been issued.

  • 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-2015-12-08/GetCertificate

GetCertificateRequest

func (c *ACM) 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 successfully.

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-2015-12-08/GetCertificate

GetCertificateWithContext

func (c *ACM) 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.

See Also

For more information about using this API, see AWS API Documentation.

ImportCertificate

func (c *ACM) ImportCertificate(input *ImportCertificateInput) (*ImportCertificateOutput, error)

ImportCertificate API operation for AWS Certificate Manager.

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services (https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html) allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the AWS Certificate Manager User Guide.

ACM does not provide managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html) for certificates that you import.

Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.

  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.

  • If the certificate you are importing is not self-signed, you must enter its certificate chain.

  • If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.

  • The certificate, private key, and certificate chain must be PEM-encoded.

  • The current time must be between the Not Before and Not After certificate fields.

  • The Issuer field must not be empty.

  • The OCSP authority URL, if present, must not exceed 1000 characters.

  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate.

  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file://. For example, you can specify a certificate saved in the C:\temp folder as file://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.

  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.

This operation returns the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the imported certificate.

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's API operation ImportCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

  • ErrCodeLimitExceededException "LimitExceededException" An ACM limit has been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/ImportCertificate

ImportCertificateRequest

func (c *ACM) ImportCertificateRequest(input *ImportCertificateInput) (req *request.Request, output *ImportCertificateOutput)

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

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 ImportCertificate for more information on using the ImportCertificate 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 ImportCertificateRequest method. req, resp := client.ImportCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/ImportCertificate

ImportCertificateWithContext

func (c *ACM) ImportCertificateWithContext(ctx aws.Context, input *ImportCertificateInput, opts ...request.Option) (*ImportCertificateOutput, error)

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

See ImportCertificate 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.

See Also

For more information about using this API, see AWS API Documentation.

ListCertificates

func (c *ACM) ListCertificates(input *ListCertificatesInput) (*ListCertificatesOutput, error)

ListCertificates API operation for AWS Certificate Manager.

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate.

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's API operation ListCertificates for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/ListCertificates

ListCertificatesPages

func (c *ACM) ListCertificatesPages(input *ListCertificatesInput, fn func(*ListCertificatesOutput, bool) bool) error

ListCertificatesPages iterates over the pages of a ListCertificates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCertificates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListCertificates operation. pageNum := 0 err := client.ListCertificatesPages(params, func(page *ListCertificatesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

ListCertificatesPagesWithContext

func (c *ACM) ListCertificatesPagesWithContext(ctx aws.Context, input *ListCertificatesInput, fn func(*ListCertificatesOutput, bool) bool, opts ...request.Option) error

ListCertificatesPagesWithContext same as ListCertificatesPages except it takes a Context and allows setting request options on the pages.

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.

See Also

For more information about using this API, see AWS API Documentation.

ListCertificatesRequest

func (c *ACM) ListCertificatesRequest(input *ListCertificatesInput) (req *request.Request, output *ListCertificatesOutput)

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

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 ListCertificates for more information on using the ListCertificates 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 ListCertificatesRequest method. req, resp := client.ListCertificatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/ListCertificates

ListCertificatesWithContext

func (c *ACM) ListCertificatesWithContext(ctx aws.Context, input *ListCertificatesInput, opts ...request.Option) (*ListCertificatesOutput, error)

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

See ListCertificates 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.

See Also

For more information about using this API, see AWS API Documentation.

ListTagsForCertificate

func (c *ACM) ListTagsForCertificate(input *ListTagsForCertificateInput) (*ListTagsForCertificateOutput, error)

ListTagsForCertificate API operation for AWS Certificate Manager.

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

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's API operation ListTagsForCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account 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-2015-12-08/ListTagsForCertificate

ListTagsForCertificateRequest

func (c *ACM) ListTagsForCertificateRequest(input *ListTagsForCertificateInput) (req *request.Request, output *ListTagsForCertificateOutput)

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

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 ListTagsForCertificate for more information on using the ListTagsForCertificate 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 ListTagsForCertificateRequest method. req, resp := client.ListTagsForCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/ListTagsForCertificate

ListTagsForCertificateWithContext

func (c *ACM) ListTagsForCertificateWithContext(ctx aws.Context, input *ListTagsForCertificateInput, opts ...request.Option) (*ListTagsForCertificateOutput, error)

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

See ListTagsForCertificate 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.

See Also

For more information about using this API, see AWS API Documentation.

RemoveTagsFromCertificate

func (c *ACM) RemoveTagsFromCertificate(input *RemoveTagsFromCertificateInput) (*RemoveTagsFromCertificateOutput, error)

RemoveTagsFromCertificate API operation for AWS Certificate Manager.

Remove one or more tags from an ACM certificate. 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 certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

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's API operation RemoveTagsFromCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

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

  • ErrCodeInvalidTagException "InvalidTagException" One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/RemoveTagsFromCertificate

RemoveTagsFromCertificateRequest

func (c *ACM) RemoveTagsFromCertificateRequest(input *RemoveTagsFromCertificateInput) (req *request.Request, output *RemoveTagsFromCertificateOutput)

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

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 RemoveTagsFromCertificate for more information on using the RemoveTagsFromCertificate 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 RemoveTagsFromCertificateRequest method. req, resp := client.RemoveTagsFromCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/RemoveTagsFromCertificate

RemoveTagsFromCertificateWithContext

func (c *ACM) RemoveTagsFromCertificateWithContext(ctx aws.Context, input *RemoveTagsFromCertificateInput, opts ...request.Option) (*RemoveTagsFromCertificateOutput, error)

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

See RemoveTagsFromCertificate 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.

See Also

For more information about using this API, see AWS API Documentation.

RequestCertificate

func (c *ACM) RequestCertificate(input *RequestCertificateInput) (*RequestCertificateOutput, error)

RequestCertificate API operation for AWS Certificate Manager.

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or email validation (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html). We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

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's API operation RequestCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededException "LimitExceededException" An ACM limit has been exceeded.

  • ErrCodeInvalidDomainValidationOptionsException "InvalidDomainValidationOptionsException" One or more values in the DomainValidationOption structure is incorrect.

  • 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-2015-12-08/RequestCertificate

RequestCertificateRequest

func (c *ACM) RequestCertificateRequest(input *RequestCertificateInput) (req *request.Request, output *RequestCertificateOutput)

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

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 RequestCertificate for more information on using the RequestCertificate 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 RequestCertificateRequest method. req, resp := client.RequestCertificateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/RequestCertificate

RequestCertificateWithContext

func (c *ACM) RequestCertificateWithContext(ctx aws.Context, input *RequestCertificateInput, opts ...request.Option) (*RequestCertificateOutput, error)

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

See RequestCertificate 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.

See Also

For more information about using this API, see AWS API Documentation.

ResendValidationEmail

func (c *ACM) ResendValidationEmail(input *ResendValidationEmailInput) (*ResendValidationEmailOutput, error)

ResendValidationEmail API operation for AWS Certificate Manager.

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain (https://docs.aws.amazon.com/acm/latest/userguide/setup-email.html).

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's API operation ResendValidationEmail for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

  • ErrCodeInvalidStateException "InvalidStateException" Processing has reached an invalid state.

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

  • ErrCodeInvalidDomainValidationOptionsException "InvalidDomainValidationOptionsException" One or more values in the DomainValidationOption structure is incorrect.

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/ResendValidationEmail

ResendValidationEmailRequest

func (c *ACM) ResendValidationEmailRequest(input *ResendValidationEmailInput) (req *request.Request, output *ResendValidationEmailOutput)

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

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 ResendValidationEmail for more information on using the ResendValidationEmail 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 ResendValidationEmailRequest method. req, resp := client.ResendValidationEmailRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/ResendValidationEmail

ResendValidationEmailWithContext

func (c *ACM) ResendValidationEmailWithContext(ctx aws.Context, input *ResendValidationEmailInput, opts ...request.Option) (*ResendValidationEmailOutput, error)

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

See ResendValidationEmail 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateCertificateOptions

func (c *ACM) UpdateCertificateOptions(input *UpdateCertificateOptionsInput) (*UpdateCertificateOptionsOutput, error)

UpdateCertificateOptions API operation for AWS Certificate Manager.

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency).

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's API operation UpdateCertificateOptions for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

  • ErrCodeLimitExceededException "LimitExceededException" An ACM limit has been exceeded.

  • ErrCodeInvalidStateException "InvalidStateException" Processing has reached an invalid state.

  • 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-2015-12-08/UpdateCertificateOptions

UpdateCertificateOptionsRequest

func (c *ACM) UpdateCertificateOptionsRequest(input *UpdateCertificateOptionsInput) (req *request.Request, output *UpdateCertificateOptionsOutput)

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

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 UpdateCertificateOptions for more information on using the UpdateCertificateOptions 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 UpdateCertificateOptionsRequest method. req, resp := client.UpdateCertificateOptionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/UpdateCertificateOptions

UpdateCertificateOptionsWithContext

func (c *ACM) UpdateCertificateOptionsWithContext(ctx aws.Context, input *UpdateCertificateOptionsInput, opts ...request.Option) (*UpdateCertificateOptionsOutput, error)

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

See UpdateCertificateOptions 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.

See Also

For more information about using this API, see AWS API Documentation.

WaitUntilCertificateValidated

func (c *ACM) WaitUntilCertificateValidated(input *DescribeCertificateInput) error

WaitUntilCertificateValidated uses the ACM API operation DescribeCertificate to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

WaitUntilCertificateValidatedWithContext

func (c *ACM) WaitUntilCertificateValidatedWithContext(ctx aws.Context, input *DescribeCertificateInput, opts ...request.WaiterOption) error

WaitUntilCertificateValidatedWithContext is an extended version of WaitUntilCertificateValidated. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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.

On this page: