FunctionEndpointSummary
A summary of a web function endpoint.
Contents
- authType
-
The authorization type for the endpoint.
Type: String
Valid Values:
ApplicationManaged | IamAuthRequired: Yes
- autoDeploymentMode
-
The auto-deployment mode for the endpoint.
Type: String
Valid Values:
LatestRevision | DisabledRequired: Yes
- createdAt
-
The date and time the endpoint was created.
Type: Timestamp
Required: Yes
- domainName
-
The domain name of the endpoint.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 256.
Pattern:
([a-z0-9-]+\.)+[a-z]+Required: Yes
- endpointArn
-
The Amazon Resource Name (ARN) of the endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- endpointName
-
The name of the endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- endpointType
-
The type of the endpoint.
Type: String
Valid Values:
HomeRegion | MultiRegion | PerRegionRequired: Yes
- regions
-
The list of Regions for the endpoint.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
([a-z]{2,}-){2,}[0-9]Required: Yes
- revisionWeights
-
The revision weights for the endpoint.
Type: Array of RevisionWeight objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: Yes
- state
-
The current state of the endpoint.
Type: String
Valid Values:
Pending | Active | Failed | DeletingRequired: Yes
- stateReason
-
The reason for the current state of the endpoint.
Type: String
Required: Yes
- updatedAt
-
The date and time the endpoint was last updated.
Type: Timestamp
Required: Yes
- description
-
A description of the endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- scalingConfig
-
The scaling configuration for the endpoint. This field is absent if the endpoint has no scaling configuration.
Type: ScalingConfig object
Required: No
- throttleConfig
-
The throttling configuration for the endpoint. This field is absent if the endpoint has no throttling configuration.
Type: ThrottleConfig object
Required: No
- updateStatus
-
The status of the most recent update to the endpoint.
Type: String
Valid Values:
InProgress | Successful | FailedRequired: No
- updateStatusReason
-
The reason for the current update status of the endpoint.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: