Class: Aws::AgentRegistryControl::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::AgentRegistryControl::Client

show all

Includes:: ClientStubs

Defined in:: gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb

Overview

An API client for AgentRegistryControl. To construct a client, you need to configure a :region and :credentials.

client = Aws::AgentRegistryControl::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

#config, #handlers

API Operations collapse

#create_registry(params = {}) ⇒ Types::CreateRegistryResponse
Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior.
#create_registry_record(params = {}) ⇒ Types::CreateRegistryRecordResponse
Creates a registry record within a registry.
#delete_registry(params = {}) ⇒ Types::DeleteRegistryResponse
Deletes a registry.
#delete_registry_record(params = {}) ⇒ Struct
Deletes a registry record.
#get_registry(params = {}) ⇒ Types::GetRegistryResponse
Gets a registry by identifier (ARN or ID).
#get_registry_record(params = {}) ⇒ Types::GetRegistryRecordResponse
Retrieves the details of a registry record.
#list_registries(params = {}) ⇒ Types::ListRegistriesResponse
Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type.
#list_registry_records(params = {}) ⇒ Types::ListRegistryRecordsResponse
Lists the registry records within a registry, with optional filtering by name, status, and record type.
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags on a resource.
#submit_registry_record_for_approval(params = {}) ⇒ Types::SubmitRegistryRecordForApprovalResponse
Submits a DRAFT registry record for approval, moving it into the registry's approval workflow.
#tag_resource(params = {}) ⇒ Struct
Tag a resource with key-value pairs.
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource by key.
#update_registry(params = {}) ⇒ Types::UpdateRegistryResponse
Updates an existing registry.
#update_registry_record(params = {}) ⇒ Types::UpdateRegistryRecordResponse
Updates a registry record.
#update_registry_record_status(params = {}) ⇒ Types::UpdateRegistryRecordStatusResponse
Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable.

Instance Method Summary collapse

#initialize(options) ⇒ Client constructor
A new instance of Client.
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Parameters:

options (Hash)

Options Hash (options):

:plugins (Array<Seahorse::Client::Plugin>) — default: []] —
A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
:credentials (required, Aws::CredentialProvider) —
Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:
- Aws::Credentials - Used for configuring static, non-refreshing credentials.
- Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.
- Aws::AssumeRoleCredentials - Used when you need to assume a role.
- Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.
- Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.
- Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.
- Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- Aws::ECSCredentials - Used for loading credentials from instances running in ECS.
- Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.
When :credentials are not configured directly, the following locations will be searched for credentials:
- Aws.config[:credentials]
- The :access_key_id, :secret_access_key, :session_token, and :account_id options.
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].
- ~/.aws/credentials
- ~/.aws/config
- EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
:region (required, String) —
The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:
- Aws.config[:region]
- ENV['AWS_REGION']
- ENV['AMAZON_REGION']
- ENV['AWS_DEFAULT_REGION']
- ~/.aws/credentials
- ~/.aws/config
:access_key_id (String)
:account_id (String)
:active_endpoint_cache (Boolean) — default: false —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.
:adaptive_retry_wait_to_fill (Boolean) — default: true —
Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.
:auth_scheme_preference (Array<String>) —
A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.
:client_side_monitoring (Boolean) — default: false —
When true, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —
Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:defaults_mode (String) — default: "legacy" —
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
:disable_host_prefix_injection (Boolean) — default: false —
When true, the SDK will not prepend the modeled host prefix to the endpoint.
:disable_request_compression (Boolean) — default: false —
When set to 'true' the request body will not be compressed for supported operations.
:endpoint (String, URI::HTTPS, URI::HTTP) —
Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:
```
'http://example.com'
'https://example.com'
'http://example.com:123'
```
:endpoint_cache_max_entries (Integer) — default: 1000 —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —
When set to true, endpoint discovery will be enabled for operations when available.
:ignore_configured_endpoint_urls (Boolean) —
Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —
The log formatter.
:log_level (Symbol) — default: :info —
The log level to send messages to the :logger at.
:logger (Logger) —
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 3 —
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.
:profile (String) — default: "default" —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
:request_checksum_calculation (String) — default: "when_supported" —
Determines when a checksum will be calculated for request payloads. Values are:
- when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
- when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
:request_min_compression_size_bytes (Integer) — default: 10240 —
The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
:response_checksum_validation (String) — default: "when_supported" —
Determines when checksum validation will be performed on response payloads. Values are:
- when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
- when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
:retry_backoff (Proc) —
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.
:retry_base_delay (Float) — default: 0.3 —
The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.
:retry_jitter (Symbol) — default: :none —
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

@see https://www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.
:retry_max_delay (Integer) — default: 0 —
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.
:retry_mode (String) — default: "legacy" —
Specifies which retry algorithm to use. Values are:
- legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.
- standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.
- adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.
:sdk_ua_app_id (String) —
A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
:secret_access_key (String)
:session_token (String)
:sigv4a_signing_region_set (Array) —
A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:
- Aws.config[:sigv4a_signing_region_set]
- ENV['AWS_SIGV4A_SIGNING_REGION_SET']
- ~/.aws/config
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —
Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:
- OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
:token_provider (Aws::TokenProvider) —
Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:
- Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.
- Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.
When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.
:use_dualstack_endpoint (Boolean) —
When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.
:use_fips_endpoint (Boolean) —
When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request.
:endpoint_provider (Aws::AgentRegistryControl::EndpointProvider) —
The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::AgentRegistryControl::EndpointParameters.
:http_continue_timeout (Float) — default: 1 —
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.
:http_idle_timeout (Float) — default: 5 —
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
:http_open_timeout (Float) — default: 15 —
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_proxy (URI::HTTP, String) —
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
:http_read_timeout (Float) — default: 60 —
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_wire_trace (Boolean) — default: false —
When true, HTTP debug output will be sent to the :logger.
:on_chunk_received (Proc) —
When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).
:on_chunk_sent (Proc) —
When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised.
:ssl_ca_bundle (String) —
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.
:ssl_ca_directory (String) —
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.
:ssl_ca_store (String) —
Sets the X509::Store to verify peer certificate.
:ssl_cert (OpenSSL::X509::Certificate) —
Sets a client certificate when creating http connections.
:ssl_key (OpenSSL::PKey) —
Sets a client key when creating http connections.
:ssl_timeout (Float) —
Sets the SSL timeout in seconds
:ssl_verify_peer (Boolean) — default: true —
When true, SSL peer certificates are verified when establishing a connection.



471
472
473

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#create_registry(params = {}) ⇒ `Types::CreateRegistryResponse`

Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior. Creation is asynchronous: the registry begins in the CREATING status and becomes usable once it reaches READY.

Examples:

Request syntax with placeholder values


resp = client.create_registry({
  name: "RegistryName", # required
  description: "Description",
  discovery_configuration: {
    authorizer_configuration: {
      custom_jwt_authorizer: {
        discovery_url: "DiscoveryUrl", # required
        allowed_audience: ["AllowedAudience"],
        allowed_clients: ["AllowedClient"],
        allowed_scopes: ["AllowedScopeType"],
        custom_claims: [
          {
            inbound_token_claim_name: "InboundTokenClaimNameType", # required
            inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
            authorizing_claim_match_value: { # required
              claim_match_value: { # required
                match_value_string: "MatchValueString",
                match_value_string_list: ["MatchValueString"],
              },
              claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
            },
          },
        ],
        private_endpoint: {
          self_managed_lattice_resource: {
            resource_configuration_identifier: "ResourceConfigurationIdentifier",
          },
          managed_vpc_resource: {
            vpc_identifier: "VpcIdentifier", # required
            subnet_ids: ["SubnetId"], # required
            endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
            security_group_ids: ["SecurityGroupIdentifier"],
            tags: {
              "TagKey" => "TagValue",
            },
            routing_domain: "RoutingDomain",
          },
        },
        private_endpoint_overrides: [
          {
            domain: "PrivateEndpointOverrideDomain", # required
            private_endpoint: { # required
              self_managed_lattice_resource: {
                resource_configuration_identifier: "ResourceConfigurationIdentifier",
              },
              managed_vpc_resource: {
                vpc_identifier: "VpcIdentifier", # required
                subnet_ids: ["SubnetId"], # required
                endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
                security_group_ids: ["SecurityGroupIdentifier"],
                tags: {
                  "TagKey" => "TagValue",
                },
                routing_domain: "RoutingDomain",
              },
            },
          },
        ],
      },
    },
    authorizer_type: "CUSTOM_JWT", # accepts CUSTOM_JWT, AWS_IAM
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
  approval_configuration: {
    auto_approval_rules: ["APPROVE_ALL"], # accepts APPROVE_ALL
  },
})

Response structure


resp.registry_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
The name of the registry
:description (String) —
The description of the registry
:discovery_configuration (Types::DiscoveryConfiguration) —
Discovery configuration for the registry
:client_token (String) —
Client token for idempotency

A suitable default value is auto-generated. You should normally not need to pass this option.**
:tags (Hash<String,String>) —
Tags to associate with the registry
:approval_configuration (Types::ApprovalConfiguration) —
Approval configuration for registry records

Returns:

(Types::CreateRegistryResponse) —
Returns a response object which responds to the following methods:
- #registry_arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 588

def create_registry(params = {}, options = {})
  req = build_request(:create_registry, params)
  req.send_request(options)
end

#create_registry_record(params = {}) ⇒ `Types::CreateRegistryRecordResponse`

Creates a registry record within a registry. A registry record describes a discoverable resource, such as an MCP server, an agent, an agent skill, or a custom resource. Creation is asynchronous: the record is returned with the CREATING status while it is processed.

Examples:

Request syntax with placeholder values


resp = client.create_registry_record({
  registry_id: "RegistryIdentifier", # required
  name: "RegistryRecordName", # required
  display_name: "RegistryRecordDisplayName",
  description: "Description",
  record_type: "MCP", # required, accepts MCP, AGENT, CUSTOM, SKILL
  descriptors: { # required
    mcp_server: {
      data: "DescriptorData",
      data_schema_version: "DataSchemaVersion",
      additional_data: {
        tools: {
          data: "DescriptorData",
          data_schema_version: "DataSchemaVersion",
        },
      },
      source: {
        from_url: {
          url: "DescriptorSourceUrl", # required
          credential_provider_configurations: [
            {
              credential_provider_type: "OAUTH", # required, accepts OAUTH, IAM
              credential_provider: { # required
                oauth_credential_provider: {
                  provider_arn: "CredentialProviderArn", # required
                  grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS
                  scopes: ["String"],
                  custom_parameters: {
                    "String" => "String",
                  },
                },
                iam_credential_provider: {
                  role_arn: "IamRoleArn",
                  service: "IamSigningServiceName",
                  region: "IamSigningRegion",
                },
              },
            },
          ],
        },
      },
    },
    a2a_agent_card: {
      data: "DescriptorData",
      data_schema_version: "DataSchemaVersion",
      source: {
        from_url: {
          url: "DescriptorSourceUrl", # required
          credential_provider_configurations: [
            {
              credential_provider_type: "OAUTH", # required, accepts OAUTH, IAM
              credential_provider: { # required
                oauth_credential_provider: {
                  provider_arn: "CredentialProviderArn", # required
                  grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS
                  scopes: ["String"],
                  custom_parameters: {
                    "String" => "String",
                  },
                },
                iam_credential_provider: {
                  role_arn: "IamRoleArn",
                  service: "IamSigningServiceName",
                  region: "IamSigningRegion",
                },
              },
            },
          ],
        },
      },
    },
    agent_skills_definition: {
      data: "DescriptorData",
      data_schema_version: "DataSchemaVersion",
      additional_data: {
        skill_md: {
          data: "DescriptorData",
          data_schema_version: "DataSchemaVersion",
          source: {
            from_url: {
              url: "DescriptorSourceUrl", # required
              credential_provider_configurations: [
                {
                  credential_provider_type: "OAUTH", # required, accepts OAUTH, IAM
                  credential_provider: { # required
                    oauth_credential_provider: {
                      provider_arn: "CredentialProviderArn", # required
                      grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS
                      scopes: ["String"],
                      custom_parameters: {
                        "String" => "String",
                      },
                    },
                    iam_credential_provider: {
                      role_arn: "IamRoleArn",
                      service: "IamSigningServiceName",
                      region: "IamSigningRegion",
                    },
                  },
                },
              ],
            },
          },
        },
      },
    },
    custom: {
      data: "DescriptorData",
    },
  },
  record_version: "RegistryRecordVersion",
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.record_arn #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry in which to create the record (ARN or ID)
:name (required, String) —
The name of the registry record
:display_name (String) —
The human-readable display name of the registry record
:description (String) —
The description of the registry record
:record_type (required, String) —
The type of the registry record, which determines the descriptor format
:descriptors (required, Types::Descriptors) —
The typed descriptor content for the registry record
:record_version (String) —
The version of the registry record
:client_token (String) —
Client token for idempotency

A suitable default value is auto-generated. You should normally not need to pass this option.**
:tags (Hash<String,String>) —
Tags to associate with the registry record

Returns:

(Types::CreateRegistryRecordResponse) —
Returns a response object which responds to the following methods:
- #record_arn => String
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 763

def create_registry_record(params = {}, options = {})
  req = build_request(:create_registry_record, params)
  req.send_request(options)
end

#delete_registry(params = {}) ⇒ `Types::DeleteRegistryResponse`

Deletes a registry. Deletion is asynchronous: the registry transitions to the DELETING status and is removed along with its registry records.

Examples:

Request syntax with placeholder values


resp = client.delete_registry({
  registry_id: "RegistryIdentifier", # required
})

Response structure


resp.status #=> String, one of "CREATING", "READY", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry to delete (ARN or ID)

Returns:

(Types::DeleteRegistryResponse) —
Returns a response object which responds to the following methods:
- #status => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 792

def delete_registry(params = {}, options = {})
  req = build_request(:delete_registry, params)
  req.send_request(options)
end

#delete_registry_record(params = {}) ⇒ `Struct`

Deletes a registry record

Examples:

Request syntax with placeholder values


resp = client.delete_registry_record({
  registry_id: "RegistryIdentifier", # required
  record_id: "RecordIdentifier", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry containing the record (ARN or ID)
:record_id (required, String) —
The identifier of the registry record to delete (ARN or ID)

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 818

def delete_registry_record(params = {}, options = {})
  req = build_request(:delete_registry_record, params)
  req.send_request(options)
end

#get_registry(params = {}) ⇒ `Types::GetRegistryResponse`

Gets a registry by identifier (ARN or ID)

The following waiters are defined for this operation (see #wait_until for detailed usage):

registry_ready

Examples:

Request syntax with placeholder values


resp = client.get_registry({
  registry_id: "RegistryIdentifier", # required
})

Response structure


resp.name #=> String
resp.description #=> String
resp.registry_id #=> String
resp.registry_arn #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.discovery_configuration.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.approval_configuration.auto_approval_rules #=> Array
resp.approval_configuration.auto_approval_rules[0] #=> String, one of "APPROVE_ALL"
resp.status #=> String, one of "CREATING", "READY", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.status_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry to retrieve (ARN or ID)

Returns:

(Types::GetRegistryResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #description => String
- #registry_id => String
- #registry_arn => String
- #discovery_configuration => Types::DiscoveryConfiguration
- #approval_configuration => Types::ApprovalConfiguration
- #status => String
- #status_reason => String
- #created_at => Time
- #updated_at => Time

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 906

def get_registry(params = {}, options = {})
  req = build_request(:get_registry, params)
  req.send_request(options)
end

#get_registry_record(params = {}) ⇒ `Types::GetRegistryRecordResponse`

Retrieves the details of a registry record

The following waiters are defined for this operation (see #wait_until for detailed usage):

registry_record_approved

Examples:

Request syntax with placeholder values


resp = client.get_registry_record({
  registry_id: "RegistryIdentifier", # required
  record_id: "RecordIdentifier", # required
})

Response structure


resp.registry_arn #=> String
resp.record_arn #=> String
resp.record_id #=> String
resp.name #=> String
resp.display_name #=> String
resp.description #=> String
resp.record_type #=> String, one of "MCP", "AGENT", "CUSTOM", "SKILL"
resp.descriptors.mcp_server.data #=> String
resp.descriptors.mcp_server.data_schema_version #=> String
resp.descriptors.mcp_server.additional_data.tools.data #=> String
resp.descriptors.mcp_server.additional_data.tools.data_schema_version #=> String
resp.descriptors.mcp_server.source.from_url.url #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations #=> Array
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider_type #=> String, one of "OAUTH", "IAM"
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS"
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["String"] #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.role_arn #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.descriptors.a2a_agent_card.data #=> String
resp.descriptors.a2a_agent_card.data_schema_version #=> String
resp.descriptors.a2a_agent_card.source.from_url.url #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations #=> Array
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider_type #=> String, one of "OAUTH", "IAM"
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS"
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["String"] #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.role_arn #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.descriptors.agent_skills_definition.data #=> String
resp.descriptors.agent_skills_definition.data_schema_version #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.data #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.data_schema_version #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.url #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations #=> Array
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider_type #=> String, one of "OAUTH", "IAM"
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS"
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["String"] #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.role_arn #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.descriptors.custom.data #=> String
resp.record_version #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status_reason #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry containing the record (ARN or ID)
:record_id (required, String) —
The identifier of the registry record to retrieve (ARN or ID)

Returns:

(Types::GetRegistryRecordResponse) —
Returns a response object which responds to the following methods:
- #registry_arn => String
- #record_arn => String
- #record_id => String
- #name => String
- #display_name => String
- #description => String
- #record_type => String
- #descriptors => Types::Descriptors
- #record_version => String
- #status => String
- #created_at => Time
- #updated_at => Time
- #status_reason => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1013

def get_registry_record(params = {}, options = {})
  req = build_request(:get_registry_record, params)
  req.send_request(options)
end

#list_registries(params = {}) ⇒ `Types::ListRegistriesResponse`

Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_registries({
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "status", # required, accepts status, discoveryConfiguration.authorizerType
      values: ["FilterValue"], # required
    },
  ],
})

Response structure


resp.registries #=> Array
resp.registries[0].name #=> String
resp.registries[0].description #=> String
resp.registries[0].registry_id #=> String
resp.registries[0].registry_arn #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.registries[0].discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.registries[0].discovery_configuration.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.registries[0].status #=> String, one of "CREATING", "READY", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.registries[0].status_reason #=> String
resp.registries[0].created_at #=> Time
resp.registries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:max_results (Integer) —
Maximum number of results to return
:next_token (String) —
Token for pagination
:filters (Array<Types::RegistryFilter>) —
Filters to apply to the registry list

Returns:

(Types::ListRegistriesResponse) —
Returns a response object which responds to the following methods:
- #registries => Array<Types::RegistrySummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1104

def list_registries(params = {}, options = {})
  req = build_request(:list_registries, params)
  req.send_request(options)
end

#list_registry_records(params = {}) ⇒ `Types::ListRegistryRecordsResponse`

Lists the registry records within a registry, with optional filtering by name, status, and record type

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_registry_records({
  registry_id: "RegistryIdentifier", # required
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "name", # required, accepts name, status, recordType
      values: ["FilterValue"], # required
    },
  ],
})

Response structure


resp.registry_records #=> Array
resp.registry_records[0].registry_arn #=> String
resp.registry_records[0].record_arn #=> String
resp.registry_records[0].record_id #=> String
resp.registry_records[0].name #=> String
resp.registry_records[0].display_name #=> String
resp.registry_records[0].description #=> String
resp.registry_records[0].record_type #=> String, one of "MCP", "AGENT", "CUSTOM", "SKILL"
resp.registry_records[0].record_version #=> String
resp.registry_records[0].status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.registry_records[0].created_at #=> Time
resp.registry_records[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry to list records from (ARN or ID)
:max_results (Integer) —
Maximum number of records to return
:next_token (String) —
Token for pagination
:filters (Array<Types::RegistryRecordFilter>) —
Filters to apply to the registry record list

Returns:

(Types::ListRegistryRecordsResponse) —
Returns a response object which responds to the following methods:
- #registry_records => Array<Types::RegistryRecordSummary>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1165

def list_registry_records(params = {}, options = {})
  req = build_request(:list_registry_records, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

List the tags on a resource

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
ARN of a taggable Agent Registry resource.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Hash<String,String>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1194

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#submit_registry_record_for_approval(params = {}) ⇒ `Types::SubmitRegistryRecordForApprovalResponse`

Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject.

Examples:

Request syntax with placeholder values


resp = client.submit_registry_record_for_approval({
  registry_id: "RegistryIdentifier", # required
  record_id: "RecordIdentifier", # required
})

Response structure


resp.registry_arn #=> String
resp.record_arn #=> String
resp.record_id #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.updated_at #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry containing the record (ARN or ID)
:record_id (required, String) —
The identifier of the registry record to submit for approval (ARN or ID)

Returns:

(Types::SubmitRegistryRecordForApprovalResponse) —
Returns a response object which responds to the following methods:
- #registry_arn => String
- #record_arn => String
- #record_id => String
- #status => String
- #updated_at => Time

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1238

def submit_registry_record_for_approval(params = {}, options = {})
  req = build_request(:submit_registry_record_for_approval, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ `Struct`

Tag a resource with key-value pairs

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
ARN of a taggable Agent Registry resource.
:tags (required, Hash<String,String>) —
A map of tag keys to tag values.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1266

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Struct`

Remove tags from a resource by key

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
ARN of a taggable Agent Registry resource.
:tag_keys (required, Array<String>) —
A list of tag keys.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1292

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_registry(params = {}) ⇒ `Types::UpdateRegistryResponse`

Updates an existing registry. This operation uses PATCH semantics: specify only the fields you want to change, and omit the rest to leave them unchanged. Updates are applied asynchronously and the registry transitions to the UPDATING status while they are processed.

Examples:

Request syntax with placeholder values


resp = client.update_registry({
  registry_id: "RegistryIdentifier", # required
  name: "RegistryName",
  description: {
    optional_value: "Description",
  },
  discovery_configuration: {
    authorizer_configuration: {
      optional_value: {
        custom_jwt_authorizer: {
          discovery_url: "DiscoveryUrl", # required
          allowed_audience: ["AllowedAudience"],
          allowed_clients: ["AllowedClient"],
          allowed_scopes: ["AllowedScopeType"],
          custom_claims: [
            {
              inbound_token_claim_name: "InboundTokenClaimNameType", # required
              inbound_token_claim_value_type: "STRING", # required, accepts STRING, STRING_ARRAY
              authorizing_claim_match_value: { # required
                claim_match_value: { # required
                  match_value_string: "MatchValueString",
                  match_value_string_list: ["MatchValueString"],
                },
                claim_match_operator: "EQUALS", # required, accepts EQUALS, CONTAINS, CONTAINS_ANY
              },
            },
          ],
          private_endpoint: {
            self_managed_lattice_resource: {
              resource_configuration_identifier: "ResourceConfigurationIdentifier",
            },
            managed_vpc_resource: {
              vpc_identifier: "VpcIdentifier", # required
              subnet_ids: ["SubnetId"], # required
              endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
              security_group_ids: ["SecurityGroupIdentifier"],
              tags: {
                "TagKey" => "TagValue",
              },
              routing_domain: "RoutingDomain",
            },
          },
          private_endpoint_overrides: [
            {
              domain: "PrivateEndpointOverrideDomain", # required
              private_endpoint: { # required
                self_managed_lattice_resource: {
                  resource_configuration_identifier: "ResourceConfigurationIdentifier",
                },
                managed_vpc_resource: {
                  vpc_identifier: "VpcIdentifier", # required
                  subnet_ids: ["SubnetId"], # required
                  endpoint_ip_address_type: "IPV4", # required, accepts IPV4, IPV6
                  security_group_ids: ["SecurityGroupIdentifier"],
                  tags: {
                    "TagKey" => "TagValue",
                  },
                  routing_domain: "RoutingDomain",
                },
              },
            },
          ],
        },
      },
    },
  },
  approval_configuration: {
    optional_value: {
      auto_approval_rules: ["APPROVE_ALL"], # accepts APPROVE_ALL
    },
  },
})

Response structure


resp.name #=> String
resp.description #=> String
resp.registry_id #=> String
resp.registry_arn #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.discovery_url #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_audience #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_audience[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_clients #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_clients[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_scopes #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.allowed_scopes[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_name #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].inbound_token_claim_value_type #=> String, one of "STRING", "STRING_ARRAY"
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_value.match_value_string_list[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.custom_claims[0].authorizing_claim_match_value.claim_match_operator #=> String, one of "EQUALS", "CONTAINS", "CONTAINS_ANY"
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags #=> Hash
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].domain #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.self_managed_lattice_resource.resource_configuration_identifier #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.vpc_identifier #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.subnet_ids[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.endpoint_ip_address_type #=> String, one of "IPV4", "IPV6"
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids #=> Array
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.security_group_ids[0] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags #=> Hash
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.tags["TagKey"] #=> String
resp.discovery_configuration.authorizer_configuration.custom_jwt_authorizer.private_endpoint_overrides[0].private_endpoint.managed_vpc_resource.routing_domain #=> String
resp.discovery_configuration.authorizer_type #=> String, one of "CUSTOM_JWT", "AWS_IAM"
resp.approval_configuration.auto_approval_rules #=> Array
resp.approval_configuration.auto_approval_rules[0] #=> String, one of "APPROVE_ALL"
resp.status #=> String, one of "CREATING", "READY", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.status_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry to update (ARN or ID)
:name (String) —
The updated name of the registry
:description (Types::UpdatedDescription) —
The updated description of the registry
:discovery_configuration (Types::UpdatedDiscoveryConfiguration) —
The updated discovery configuration. Changing the discovery authorization can break existing consumers that rely on the previous authorization type.
:approval_configuration (Types::UpdatedApprovalConfiguration) —
The updated approval configuration. The change applies only to records that move to PENDING_APPROVAL after the update; records already in PENDING_APPROVAL are unaffected.

Returns:

(Types::UpdateRegistryResponse) —
Returns a response object which responds to the following methods:
- #name => String
- #description => String
- #registry_id => String
- #registry_arn => String
- #discovery_configuration => Types::DiscoveryConfiguration
- #approval_configuration => Types::ApprovalConfiguration
- #status => String
- #status_reason => String
- #created_at => Time
- #updated_at => Time

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1463

def update_registry(params = {}, options = {})
  req = build_request(:update_registry, params)
  req.send_request(options)
end

#update_registry_record(params = {}) ⇒ `Types::UpdateRegistryRecordResponse`

Updates a registry record. The update is asynchronous: the record is returned with the UPDATING status while it is processed. Fields that use update wrappers follow PATCH semantics: omit the field to leave it unchanged.

Examples:

Request syntax with placeholder values


resp = client.update_registry_record({
  registry_id: "RegistryIdentifier", # required
  record_id: "RecordIdentifier", # required
  name: "RegistryRecordName",
  display_name: {
    optional_value: "RegistryRecordDisplayName",
  },
  description: {
    optional_value: "Description",
  },
  record_type: "MCP", # accepts MCP, AGENT, CUSTOM, SKILL
  descriptors: {
    optional_value: {
      mcp_server: {
        optional_value: {
          data: {
            optional_value: "DescriptorData",
          },
          data_schema_version: {
            optional_value: "DataSchemaVersion",
          },
          source: {
            optional_value: {
              from_url: {
                url: "DescriptorSourceUrl", # required
                credential_provider_configurations: [
                  {
                    credential_provider_type: "OAUTH", # required, accepts OAUTH, IAM
                    credential_provider: { # required
                      oauth_credential_provider: {
                        provider_arn: "CredentialProviderArn", # required
                        grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS
                        scopes: ["String"],
                        custom_parameters: {
                          "String" => "String",
                        },
                      },
                      iam_credential_provider: {
                        role_arn: "IamRoleArn",
                        service: "IamSigningServiceName",
                        region: "IamSigningRegion",
                      },
                    },
                  },
                ],
              },
            },
          },
          additional_data: {
            optional_value: {
              tools: {
                optional_value: {
                  data: {
                    optional_value: "DescriptorData",
                  },
                  data_schema_version: {
                    optional_value: "DataSchemaVersion",
                  },
                },
              },
            },
          },
        },
      },
      a2a_agent_card: {
        optional_value: {
          data: {
            optional_value: "DescriptorData",
          },
          data_schema_version: {
            optional_value: "DataSchemaVersion",
          },
          source: {
            optional_value: {
              from_url: {
                url: "DescriptorSourceUrl", # required
                credential_provider_configurations: [
                  {
                    credential_provider_type: "OAUTH", # required, accepts OAUTH, IAM
                    credential_provider: { # required
                      oauth_credential_provider: {
                        provider_arn: "CredentialProviderArn", # required
                        grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS
                        scopes: ["String"],
                        custom_parameters: {
                          "String" => "String",
                        },
                      },
                      iam_credential_provider: {
                        role_arn: "IamRoleArn",
                        service: "IamSigningServiceName",
                        region: "IamSigningRegion",
                      },
                    },
                  },
                ],
              },
            },
          },
        },
      },
      agent_skills_definition: {
        optional_value: {
          data: {
            optional_value: "DescriptorData",
          },
          data_schema_version: {
            optional_value: "DataSchemaVersion",
          },
          additional_data: {
            optional_value: {
              skill_md: {
                optional_value: {
                  data: {
                    optional_value: "DescriptorData",
                  },
                  data_schema_version: {
                    optional_value: "DataSchemaVersion",
                  },
                  source: {
                    optional_value: {
                      from_url: {
                        url: "DescriptorSourceUrl", # required
                        credential_provider_configurations: [
                          {
                            credential_provider_type: "OAUTH", # required, accepts OAUTH, IAM
                            credential_provider: { # required
                              oauth_credential_provider: {
                                provider_arn: "CredentialProviderArn", # required
                                grant_type: "CLIENT_CREDENTIALS", # accepts CLIENT_CREDENTIALS
                                scopes: ["String"],
                                custom_parameters: {
                                  "String" => "String",
                                },
                              },
                              iam_credential_provider: {
                                role_arn: "IamRoleArn",
                                service: "IamSigningServiceName",
                                region: "IamSigningRegion",
                              },
                            },
                          },
                        ],
                      },
                    },
                  },
                },
              },
            },
          },
        },
      },
      custom: {
        optional_value: {
          data: {
            optional_value: "DescriptorData",
          },
        },
      },
    },
  },
  record_version: "RegistryRecordVersion",
  trigger_synchronization: false,
})

Response structure


resp.registry_arn #=> String
resp.record_arn #=> String
resp.record_id #=> String
resp.name #=> String
resp.display_name #=> String
resp.description #=> String
resp.record_type #=> String, one of "MCP", "AGENT", "CUSTOM", "SKILL"
resp.descriptors.mcp_server.data #=> String
resp.descriptors.mcp_server.data_schema_version #=> String
resp.descriptors.mcp_server.additional_data.tools.data #=> String
resp.descriptors.mcp_server.additional_data.tools.data_schema_version #=> String
resp.descriptors.mcp_server.source.from_url.url #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations #=> Array
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider_type #=> String, one of "OAUTH", "IAM"
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS"
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["String"] #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.role_arn #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.descriptors.mcp_server.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.descriptors.a2a_agent_card.data #=> String
resp.descriptors.a2a_agent_card.data_schema_version #=> String
resp.descriptors.a2a_agent_card.source.from_url.url #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations #=> Array
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider_type #=> String, one of "OAUTH", "IAM"
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS"
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["String"] #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.role_arn #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.descriptors.a2a_agent_card.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.descriptors.agent_skills_definition.data #=> String
resp.descriptors.agent_skills_definition.data_schema_version #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.data #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.data_schema_version #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.url #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations #=> Array
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider_type #=> String, one of "OAUTH", "IAM"
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.provider_arn #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.grant_type #=> String, one of "CLIENT_CREDENTIALS"
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes #=> Array
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.scopes[0] #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters #=> Hash
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.oauth_credential_provider.custom_parameters["String"] #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.role_arn #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.service #=> String
resp.descriptors.agent_skills_definition.additional_data.skill_md.source.from_url.credential_provider_configurations[0].credential_provider.iam_credential_provider.region #=> String
resp.descriptors.custom.data #=> String
resp.record_version #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.status_reason #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry containing the record (ARN or ID)
:record_id (required, String) —
The identifier of the registry record to update (ARN or ID)
:name (String) —
The updated name of the registry record. Omit to leave the name unchanged.
:display_name (Types::UpdatedDisplayName) —
The updated display name of the registry record. Omit to leave the display name unchanged; provide an empty wrapper to unset it.
:description (Types::UpdatedDescription) —
The updated description of the registry record. Omit to leave the description unchanged; provide an empty wrapper to unset it.
:record_type (String) —
The updated type of the registry record. Omit to leave the record type unchanged.
:descriptors (Types::UpdatedDescriptors) —
The updated typed descriptor content for the registry record. Omit to leave the descriptors unchanged.
:record_version (String) —
The updated version of the registry record. Omit to leave the version unchanged.
:trigger_synchronization (Boolean) —
Whether to trigger synchronization of the record's descriptor content from its source

Returns:

(Types::UpdateRegistryRecordResponse) —
Returns a response object which responds to the following methods:
- #registry_arn => String
- #record_arn => String
- #record_id => String
- #name => String
- #display_name => String
- #description => String
- #record_type => String
- #descriptors => Types::Descriptors
- #record_version => String
- #status => String
- #created_at => Time
- #updated_at => Time
- #status_reason => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1756

def update_registry_record(params = {}, options = {})
  req = build_request(:update_registry_record, params)
  req.send_request(options)
end

#update_registry_record_status(params = {}) ⇒ `Types::UpdateRegistryRecordStatusResponse`

Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable

Examples:

Request syntax with placeholder values


resp = client.update_registry_record_status({
  registry_id: "RegistryIdentifier", # required
  record_id: "RecordIdentifier", # required
  status: "DRAFT", # required, accepts DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, DEPRECATED, CREATING, UPDATING, CREATE_FAILED, UPDATE_FAILED
  status_reason: "UpdateRegistryRecordStatusRequestStatusReasonString", # required
})

Response structure


resp.registry_arn #=> String
resp.record_arn #=> String
resp.record_id #=> String
resp.status #=> String, one of "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED", "CREATING", "UPDATING", "CREATE_FAILED", "UPDATE_FAILED"
resp.status_reason #=> String
resp.updated_at #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:registry_id (required, String) —
The identifier of the registry containing the record (ARN or ID)
:record_id (required, String) —
The identifier of the registry record to update the status of (ARN or ID)
:status (required, String) —
The target status for the registry record
:status_reason (required, String) —
The reason for the status change, for example why the record was approved, rejected, or deprecated

Returns:

(Types::UpdateRegistryRecordStatusResponse) —
Returns a response object which responds to the following methods:
- #registry_arn => String
- #record_arn => String
- #record_id => String
- #status => String
- #status_reason => String
- #updated_at => Time

See Also:

AWS API Documentation

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1811

def update_registry_record_status(params = {}, options = {})
  req = build_request(:update_registry_record_status, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ `Boolean`

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

It is successful
It enters a terminal state
It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name	params	:delay	:max_attempts
registry_ready	#get_registry	30	5
registry_record_approved	#get_registry_record	30	5

Parameters:

waiter_name (Symbol)
params (Hash) (defaults to: {}) —
({})
options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:max_attempts (Integer)
:delay (Integer)
:before_attempt (Proc)
:before_wait (Proc)

Yields:

(w.waiter)

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

# File 'gems/aws-sdk-agentregistrycontrol/lib/aws-sdk-agentregistrycontrol/client.rb', line 1927

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end

Class: Aws::AgentRegistryControl::Client

Overview

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options) ⇒ Client

Instance Method Details

#create_registry(params = {}) ⇒ Types::CreateRegistryResponse

Examples:

Request syntax with placeholder values

Response structure

#create_registry_record(params = {}) ⇒ Types::CreateRegistryRecordResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_registry(params = {}) ⇒ Types::DeleteRegistryResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_registry_record(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#get_registry(params = {}) ⇒ Types::GetRegistryResponse

Examples:

Request syntax with placeholder values

Response structure

#get_registry_record(params = {}) ⇒ Types::GetRegistryRecordResponse

Examples:

Request syntax with placeholder values

Response structure

#list_registries(params = {}) ⇒ Types::ListRegistriesResponse

Examples:

Request syntax with placeholder values

Response structure

#list_registry_records(params = {}) ⇒ Types::ListRegistryRecordsResponse

Examples:

Request syntax with placeholder values

Response structure

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Examples:

Request syntax with placeholder values

Response structure

#submit_registry_record_for_approval(params = {}) ⇒ Types::SubmitRegistryRecordForApprovalResponse

Examples:

Request syntax with placeholder values

Response structure

#tag_resource(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#untag_resource(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#update_registry(params = {}) ⇒ Types::UpdateRegistryResponse

Examples:

Request syntax with placeholder values

Response structure

#update_registry_record(params = {}) ⇒ Types::UpdateRegistryRecordResponse

Examples:

Request syntax with placeholder values

Response structure

#update_registry_record_status(params = {}) ⇒ Types::UpdateRegistryRecordStatusResponse

Examples:

Request syntax with placeholder values

Response structure

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

Valid Waiters

#initialize(options) ⇒ `Client`

#create_registry(params = {}) ⇒ `Types::CreateRegistryResponse`

#create_registry_record(params = {}) ⇒ `Types::CreateRegistryRecordResponse`

#delete_registry(params = {}) ⇒ `Types::DeleteRegistryResponse`

#delete_registry_record(params = {}) ⇒ `Struct`

#get_registry(params = {}) ⇒ `Types::GetRegistryResponse`

#get_registry_record(params = {}) ⇒ `Types::GetRegistryRecordResponse`

#list_registries(params = {}) ⇒ `Types::ListRegistriesResponse`

#list_registry_records(params = {}) ⇒ `Types::ListRegistryRecordsResponse`

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

#submit_registry_record_for_approval(params = {}) ⇒ `Types::SubmitRegistryRecordForApprovalResponse`

#tag_resource(params = {}) ⇒ `Struct`

#untag_resource(params = {}) ⇒ `Struct`

#update_registry(params = {}) ⇒ `Types::UpdateRegistryResponse`

#update_registry_record(params = {}) ⇒ `Types::UpdateRegistryRecordResponse`

#update_registry_record_status(params = {}) ⇒ `Types::UpdateRegistryRecordStatusResponse`

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ `Boolean`