schemas function

Schemas

Amazon EventBridge Schema Registry

schemas(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

• config: Optional configuration of credentials, endpoint, and/or region.

  • credentials :

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token

    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint : The complete URL to use for the constructed client.

  • region : The AWS Region used in instantiating the client.

  • close_connection : Immediately close all HTTP connections.

  • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

  • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

• credentials: Optional credentials shorthand for the config parameter

  • creds :

    • access_key_id : AWS access key ID
    • secret_access_key : AWS secret access key
    • session_token : AWS temporary session token

  • profile : The name of a profile to use. If not given, then the default profile is used.

  • anonymous : Set anonymous credentials.

• endpoint: Optional shorthand for complete URL to use for the constructed client.

• region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- schemas(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_discoverer	Creates a discoverer
create_registry	Creates a registry
create_schema	Creates a schema definition
delete_discoverer	Deletes a discoverer
delete_registry	Deletes a Registry
delete_resource_policy	Delete the resource-based policy attached to the specified registry
delete_schema	Delete a schema definition
delete_schema_version	Delete the schema version definition
describe_code_binding	Describe the code binding URI
describe_discoverer	Describes the discoverer
describe_registry	Describes the registry
describe_schema	Retrieve the schema definition
export_schema	Export schema
get_code_binding_source	Get the code binding source URI
get_discovered_schema	Get the discovered schema that was generated based on sampled events
get_resource_policy	Retrieves the resource-based policy attached to a given registry
list_discoverers	List the discoverers
list_registries	List the registries
list_schemas	List the schemas
list_schema_versions	Provides a list of the schema versions and related information
list_tags_for_resource	Get tags for resource
put_code_binding	Put code binding URI
put_resource_policy	The name of the policy
search_schemas	Search the schemas
start_discoverer	Starts the discoverer
stop_discoverer	Stops the discoverer
tag_resource	Add tags to a resource
untag_resource	Removes tags from a resource
update_discoverer	Updates the discoverer
update_registry	Updates a registry
update_schema	Updates the schema definition

Examples

## Not run:

svc <- schemas()
svc$create_discoverer(
  Foo = 123
)
## End(Not run)