Class: Aws::PcaConnectorScep::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PcaConnectorScep::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb
Overview
An API client for PcaConnectorScep. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::PcaConnectorScep::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_challenge(params = {}) ⇒ Types::CreateChallengeResponse
For general-purpose connectors.
-
#create_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates a SCEP connector.
-
#delete_challenge(params = {}) ⇒ Struct
Deletes the specified [Challenge][1].
-
#delete_connector(params = {}) ⇒ Struct
Deletes the specified [Connector][1].
-
#get_challenge_metadata(params = {}) ⇒ Types::GetChallengeMetadataResponse
Retrieves the metadata for the specified [Challenge][1].
-
#get_challenge_password(params = {}) ⇒ Types::GetChallengePasswordResponse
Retrieves the challenge password for the specified [Challenge][1].
-
#get_connector(params = {}) ⇒ Types::GetConnectorResponse
Retrieves details about the specified [Connector][1].
-
#list_challenge_metadata(params = {}) ⇒ Types::ListChallengeMetadataResponse
Retrieves the challenge metadata for the specified ARN.
-
#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse
Lists the connectors belonging to your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the tags associated with the specified resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to your resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from your resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
434 435 436 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 434 def initialize(*args) super end |
Instance Method Details
#create_challenge(params = {}) ⇒ Types::CreateChallengeResponse
For general-purpose connectors. Creates a challenge password for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call ListConnectors.
To create additional challenge passwords for the connector, call
CreateChallenge
again. We recommend frequently rotating your
challenge passwords.
506 507 508 509 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 506 def create_challenge(params = {}, = {}) req = build_request(:create_challenge, params) req.send_request() end |
#create_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.
605 606 607 608 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 605 def create_connector(params = {}, = {}) req = build_request(:create_connector, params) req.send_request() end |
#delete_challenge(params = {}) ⇒ Struct
Deletes the specified Challenge.
631 632 633 634 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 631 def delete_challenge(params = {}, = {}) req = build_request(:delete_challenge, params) req.send_request() end |
#delete_connector(params = {}) ⇒ Struct
Deletes the specified Connector. This operation also deletes any challenges associated with the connector.
658 659 660 661 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 658 def delete_connector(params = {}, = {}) req = build_request(:delete_connector, params) req.send_request() end |
#get_challenge_metadata(params = {}) ⇒ Types::GetChallengeMetadataResponse
Retrieves the metadata for the specified Challenge.
693 694 695 696 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 693 def (params = {}, = {}) req = build_request(:get_challenge_metadata, params) req.send_request() end |
#get_challenge_password(params = {}) ⇒ Types::GetChallengePasswordResponse
Retrieves the challenge password for the specified Challenge.
725 726 727 728 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 725 def get_challenge_password(params = {}, = {}) req = build_request(:get_challenge_password, params) req.send_request() end |
#get_connector(params = {}) ⇒ Types::GetConnectorResponse
Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.
771 772 773 774 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 771 def get_connector(params = {}, = {}) req = build_request(:get_connector, params) req.send_request() end |
#list_challenge_metadata(params = {}) ⇒ Types::ListChallengeMetadataResponse
Retrieves the challenge metadata for the specified ARN.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
822 823 824 825 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 822 def (params = {}, = {}) req = build_request(:list_challenge_metadata, params) req.send_request() end |
#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse
Lists the connectors belonging to your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
878 879 880 881 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 878 def list_connectors(params = {}, = {}) req = build_request(:list_connectors, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the tags associated with the specified resource. Tags are key-value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
912 913 914 915 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 912 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to your resource.
940 941 942 943 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 940 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from your resource.
967 968 969 970 |
# File 'gems/aws-sdk-pcaconnectorscep/lib/aws-sdk-pcaconnectorscep/client.rb', line 967 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |