Skip to content

Add endpoint id property to service trait#663

Merged
srchase merged 3 commits intosmithy-lang:masterfrom
JordonPhillips:endpoint-prefix
Dec 10, 2020
Merged

Add endpoint id property to service trait#663
srchase merged 3 commits intosmithy-lang:masterfrom
JordonPhillips:endpoint-prefix

Conversation

@JordonPhillips
Copy link
Copy Markdown
Contributor

Description of changes:

This adds the endpointId property to the AWS service trait so that
endpoints may be constructed when given a region.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

This adds the endpointId property to the AWS service trait so that
endpoints may be constructed when given a region.
The ``endpointPrefix`` property is a ``string`` value that identifies which endpoint
in a given region should be used to connect to the service. For example, most
services in the AWS standard partition have endpoints which follow the format:
``{endpointPrefix}.{region}.amazonaws.com``. A service with the endpoint id
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

forgot this instance of "endpoint id"

``example.us-west-2.amazonaws.com``. For a full listing of possible endpoints,
check the `AWS Regions and Endpoints`_ page.

This value is not unique across services and is subject to change. Therefore,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. Should we also say that this can be used to attempt to resolve endpoints?

@srchase srchase merged commit aeedc5e into smithy-lang:master Dec 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants