Retrieves multiple schemas by their identifiers.
" }, + "BatchGetSchemaAnalysisRule":{ + "name":"BatchGetSchemaAnalysisRule", + "http":{ + "method":"POST", + "requestUri":"/collaborations/{collaborationIdentifier}/batch-schema-analysis-rule", + "responseCode":200 + }, + "input":{"shape":"BatchGetSchemaAnalysisRuleInput"}, + "output":{"shape":"BatchGetSchemaAnalysisRuleOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves multiple analysis rule schemas.
" + }, "CreateAnalysisTemplate":{ "name":"CreateAnalysisTemplate", "http":{ @@ -1391,11 +1409,11 @@ "members":{ "allowedAnalyses":{ "shape":"AnalysisRuleCustomAllowedAnalysesList", - "documentation":"The analysis templates that are allowed by the custom analysis rule.
" + "documentation":"The ARN of the analysis templates that are allowed by the custom analysis rule.
" }, "allowedAnalysisProviders":{ "shape":"AnalysisRuleCustomAllowedAnalysisProvidersList", - "documentation":"The Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.
The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.
An error name for the error.
" + }, + "type":{ + "shape":"AnalysisRuleType", + "documentation":"The analysis rule type.
" + }, + "code":{ + "shape":"String", + "documentation":"An error code for the error.
" + }, + "message":{ + "shape":"String", + "documentation":"A description of why the call failed.
" + } + }, + "documentation":"An error that describes why a schema could not be fetched.
" + }, + "BatchGetSchemaAnalysisRuleErrorList":{ + "type":"list", + "member":{"shape":"BatchGetSchemaAnalysisRuleError"}, + "max":25, + "min":0 + }, + "BatchGetSchemaAnalysisRuleInput":{ + "type":"structure", + "required":[ + "collaborationIdentifier", + "schemaAnalysisRuleRequests" + ], + "members":{ + "collaborationIdentifier":{ + "shape":"CollaborationIdentifier", + "documentation":"The unique identifier of the collaboration that contains the schema analysis rule.
", + "location":"uri", + "locationName":"collaborationIdentifier" + }, + "schemaAnalysisRuleRequests":{ + "shape":"SchemaAnalysisRuleRequestList", + "documentation":"The information that's necessary to retrieve a schema analysis rule.
" + } + } + }, + "BatchGetSchemaAnalysisRuleOutput":{ + "type":"structure", + "required":[ + "analysisRules", + "errors" + ], + "members":{ + "analysisRules":{ + "shape":"SchemaAnalysisRuleList", + "documentation":"The retrieved list of analysis rules.
" + }, + "errors":{ + "shape":"BatchGetSchemaAnalysisRuleErrorList", + "documentation":"Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
" + } + } + }, "BatchGetSchemaError":{ "type":"structure", "required":[ @@ -1780,7 +1868,7 @@ }, "names":{ "shape":"TableAliasList", - "documentation":"The names for the schema objects to retrieve.>
" + "documentation":"The names for the schema objects to retrieve.
" } } }, @@ -5950,19 +6038,30 @@ "ScalarFunctions":{ "type":"string", "enum":[ - "TRUNC", "ABS", + "CAST", "CEILING", + "COALESCE", + "CONVERT", + "CURRENT_DATE", + "DATEADD", + "EXTRACT", "FLOOR", + "GETDATE", "LN", "LOG", - "ROUND", - "SQRT", - "CAST", "LOWER", + "ROUND", "RTRIM", - "UPPER", - "COALESCE" + "SQRT", + "SUBSTRING", + "TO_CHAR", + "TO_DATE", + "TO_NUMBER", + "TO_TIMESTAMP", + "TRIM", + "TRUNC", + "UPPER" ] }, "ScalarFunctionsList":{ @@ -5982,7 +6081,8 @@ "description", "createTime", "updateTime", - "type" + "type", + "schemaStatusDetails" ], "members":{ "columns":{ @@ -6032,16 +6132,123 @@ "type":{ "shape":"SchemaType", "documentation":"The type of schema. The only valid value is currently `TABLE`.
" + }, + "schemaStatusDetails":{ + "shape":"SchemaStatusDetailList", + "documentation":"Details about the status of the schema. Currently, only one entry is present.
" } }, "documentation":"A schema is a relation within a collaboration.
" }, + "SchemaAnalysisRuleList":{ + "type":"list", + "member":{"shape":"AnalysisRule"}, + "max":25, + "min":0 + }, + "SchemaAnalysisRuleRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"TableAlias", + "documentation":"The name of the analysis rule schema that you are requesting.
" + }, + "type":{ + "shape":"AnalysisRuleType", + "documentation":"The type of analysis rule schema that you are requesting.
" + } + }, + "documentation":"Defines the information that's necessary to retrieve an analysis rule schema. Schema analysis rules are uniquely identified by a combination of the schema name and the analysis rule type for a given collaboration.
" + }, + "SchemaAnalysisRuleRequestList":{ + "type":"list", + "member":{"shape":"SchemaAnalysisRuleRequest"}, + "max":25, + "min":1 + }, + "SchemaConfiguration":{ + "type":"string", + "enum":["DIFFERENTIAL_PRIVACY"] + }, + "SchemaConfigurationList":{ + "type":"list", + "member":{"shape":"SchemaConfiguration"} + }, "SchemaList":{ "type":"list", "member":{"shape":"Schema"}, "max":25, "min":0 }, + "SchemaStatus":{ + "type":"string", + "enum":[ + "READY", + "NOT_READY" + ] + }, + "SchemaStatusDetail":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"SchemaStatus", + "documentation":"The status of the schema.
" + }, + "reasons":{ + "shape":"SchemaStatusReasonList", + "documentation":"The reasons why the schema status is set to its current state.
" + }, + "analysisRuleType":{ + "shape":"AnalysisRuleType", + "documentation":"The analysis rule type for which the schema status has been evaluated.
" + }, + "configurations":{ + "shape":"SchemaConfigurationList", + "documentation":"The configuration details of the schema analysis rule for the given type.
" + } + }, + "documentation":"Information about the schema status.
A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.
The schema status reason code.
" + }, + "message":{ + "shape":"String", + "documentation":"An explanation of the schema status reason code.
" + } + }, + "documentation":"A reason why the schema status is set to its current value.
" + }, + "SchemaStatusReasonCode":{ + "type":"string", + "enum":[ + "ANALYSIS_RULE_MISSING", + "ANALYSIS_TEMPLATES_NOT_CONFIGURED", + "ANALYSIS_PROVIDERS_NOT_CONFIGURED", + "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED" + ] + }, + "SchemaStatusReasonList":{ + "type":"list", + "member":{"shape":"SchemaStatusReason"} + }, "SchemaSummary":{ "type":"structure", "required":[ diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 65943e48de..af7bfce6d4 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -36938,7 +36938,17 @@ "r7iz.metal-32xl", "c7gd.metal", "m7gd.metal", - "r7gd.metal" + "r7gd.metal", + "g6.xlarge", + "g6.2xlarge", + "g6.4xlarge", + "g6.8xlarge", + "g6.12xlarge", + "g6.16xlarge", + "g6.24xlarge", + "g6.48xlarge", + "gr6.4xlarge", + "gr6.8xlarge" ] }, "InstanceTypeHypervisor":{ diff --git a/botocore/data/emr-containers/2020-10-01/service-2.json b/botocore/data/emr-containers/2020-10-01/service-2.json index 218a5426b8..1dadc66505 100644 --- a/botocore/data/emr-containers/2020-10-01/service-2.json +++ b/botocore/data/emr-containers/2020-10-01/service-2.json @@ -67,7 +67,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} + {"shape":"InternalServerException"}, + {"shape":"EKSRequestThrottledException"} ], "documentation":"Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
" }, @@ -318,6 +319,7 @@ "max":5000, "pattern":"^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" }, + "Boolean":{"type":"boolean"}, "CancelJobRunRequest":{ "type":"structure", "required":[ @@ -856,6 +858,15 @@ } } }, + "EKSRequestThrottledException":{ + "type":"structure", + "members":{ + "message":{"shape":"String1024"} + }, + "documentation":"The request exceeded the Amazon EKS API operation limits.
", + "error":{"httpStatusCode":429}, + "exception":true + }, "EksInfo":{ "type":"structure", "members":{ @@ -1531,6 +1542,12 @@ "documentation":"The token for the next set of virtual clusters to return.
", "location":"querystring", "locationName":"nextToken" + }, + "eksAccessEntryIntegrated":{ + "shape":"Boolean", + "documentation":"Optional Boolean that specifies whether the operation should return the virtual clusters that have the access entry integration enabled or disabled. If not specified, the operation returns all applicable virtual clusters.
", + "location":"querystring", + "locationName":"eksAccessEntryIntegrated" } } }, @@ -2107,5 +2124,5 @@ "member":{"shape":"VirtualCluster"} } }, - "documentation":"Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. For more information about Amazon EMR on EKS concepts and tasks, see What is shared id=\"EMR-EKS\"/>.
Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following scenarios:
It is the prefix in the CLI commands for Amazon EMR on EKS. For example, aws emr-containers start-job-run.
It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, \"Action\": [ \"emr-containers:StartJobRun\"]. For more information, see Policy actions for Amazon EMR on EKS.
It is the prefix used in Amazon EMR on EKS service endpoints. For example, emr-containers.us-east-2.amazonaws.com. For more information, see Amazon EMR on EKSService Endpoints.
Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. For more information about Amazon EMR on EKS concepts and tasks, see What is Amazon EMR on EKS.
Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following scenarios:
It is the prefix in the CLI commands for Amazon EMR on EKS. For example, aws emr-containers start-job-run.
It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, \"Action\": [ \"emr-containers:StartJobRun\"]. For more information, see Policy actions for Amazon EMR on EKS.
It is the prefix used in Amazon EMR on EKS service endpoints. For example, emr-containers.us-east-2.amazonaws.com. For more information, see Amazon EMR on EKSService Endpoints.
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: \"\" (empty string, recording is disabled).
" }, + "srt":{ + "shape":"Srt", + "documentation":"Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
" + }, "tags":{ "shape":"Tags", "documentation":"Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Whether the channel allows insecure RTMP ingest. Default: false.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
The endpoint to be used when streaming with IVS using the SRT protocol.
" + }, + "passphrase":{ + "shape":"SrtPassphrase", + "documentation":"Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.
Specifies information needed to stream using the SRT protocol.
" + }, + "SrtEndpoint":{"type":"string"}, + "SrtPassphrase":{ + "type":"string", + "sensitive":true + }, "StartViewerSessionRevocationRequest":{ "type":"structure", "required":[ @@ -2520,7 +2543,7 @@ }, "insecureIngest":{ "shape":"Boolean", - "documentation":"Whether the channel allows insecure RTMP ingest. Default: false.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.
All API request parameters and URLs are case sensitive.
For a summary of notable documentation changes in each release, see Document History.
Allowed Header Values
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. Treat the stream key like a secret, since it allows anyone to stream to the channel.
Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.
Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.
Playback restriction policy — Restricts playback by countries and/or origin sites. See the Playback Restriction Policy endpoints for more information.
Tagging
A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.
At most 50 tags can be applied to a resource.
Authentication versus Authorization
Note the differences between these concepts:
Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels. (Private channels are channels that are enabled for \"playback authorization.\")
Authentication
All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.
You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Channel Endpoints
CreateChannel — Creates a new channel and an associated stream key to start streaming.
GetChannel — Gets the channel configuration for the specified channel ARN.
BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
ListChannels — Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).
UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
DeleteChannel — Deletes the specified channel.
Playback Restriction Policy Endpoints
CreatePlaybackRestrictionPolicy — Creates a new playback restriction policy, for constraining playback by countries and/or origins.
DeletePlaybackRestrictionPolicy — Deletes the specified playback restriction policy
GetPlaybackRestrictionPolicy — Gets the specified playback restriction policy.
ListPlaybackRestrictionPolicies — Gets summary information about playback restriction policies.
UpdatePlaybackRestrictionPolicy — Updates a specified playback restriction policy.
Private Channel Endpoints
For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
ImportPlaybackKeyPair — Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).
GetPlaybackKeyPair — Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.
ListPlaybackKeyPairs — Gets summary information about playback key pairs.
DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.
StartViewerSessionRevocation — Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version.
BatchStartViewerSessionRevocation — Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
RecordingConfiguration Endpoints
CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.
GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.
ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.
Stream Endpoints
GetStream — Gets information about the active (live) stream on a specified channel.
GetStreamSession — Gets metadata on a specified stream.
ListStreams — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
ListStreamSessions — Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
PutMetadata — Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.
StreamKey Endpoints
CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.
GetStreamKey — Gets stream key information for the specified ARN.
BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.
ListStreamKeys — Gets summary information about stream keys for the specified channel.
DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Amazon Web Services Tags Endpoints
TagResource — Adds or updates tags for the Amazon Web Services resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.
Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.
All API request parameters and URLs are case sensitive.
For a summary of notable documentation changes in each release, see Document History.
Allowed Header Values
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json
Key Concepts
Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. Treat the stream key like a secret, since it allows anyone to stream to the channel.
Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.
Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.
Playback restriction policy — Restricts playback by countries and/or origin sites.
For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
Tagging
A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.
At most 50 tags can be applied to a resource.
Authentication versus Authorization
Note the differences between these concepts:
Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels. (Private channels are channels that are enabled for \"playback authorization.\")
Authentication
All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.
You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
Channel Endpoints
CreateChannel — Creates a new channel and an associated stream key to start streaming.
GetChannel — Gets the channel configuration for the specified channel ARN.
BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
ListChannels — Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).
UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
DeleteChannel — Deletes the specified channel.
Playback Restriction Policy Endpoints
CreatePlaybackRestrictionPolicy — Creates a new playback restriction policy, for constraining playback by countries and/or origins.
DeletePlaybackRestrictionPolicy — Deletes the specified playback restriction policy
GetPlaybackRestrictionPolicy — Gets the specified playback restriction policy.
ListPlaybackRestrictionPolicies — Gets summary information about playback restriction policies.
UpdatePlaybackRestrictionPolicy — Updates a specified playback restriction policy.
Private Channel Endpoints
For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
ImportPlaybackKeyPair — Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).
GetPlaybackKeyPair — Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.
ListPlaybackKeyPairs — Gets summary information about playback key pairs.
DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.
StartViewerSessionRevocation — Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version.
BatchStartViewerSessionRevocation — Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
Recording Configuration Endpoints
CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.
GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.
ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.
Stream Endpoints
GetStream — Gets information about the active (live) stream on a specified channel.
GetStreamSession — Gets metadata on a specified stream.
ListStreams — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
ListStreamSessions — Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
PutMetadata — Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.
Stream Key Endpoints
CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.
GetStreamKey — Gets stream key information for the specified ARN.
BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.
ListStreamKeys — Gets summary information about stream keys for the specified channel.
DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Amazon Web Services Tags Endpoints
TagResource — Adds or updates tags for the Amazon Web Services resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.
Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?
" + "documentation":"Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.
Specifies the resource for which the authorization decision is to be made.
" + "documentation":"Specifies the resource that you want an authorization decision for. For example, PhotoFlash::Photo.
Errors that occurred while making an authorization decision, for example, a policy references an Entity or entity Attribute that does not exist in the slice.
" + "documentation":"Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.
" } }, "documentation":"The decision, based on policy evaluation, from an individual authorization request in a BatchIsAuthorized API request.
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of a CognitoUserPoolConfiguration structure and is a request parameter in CreateIdentitySource.
" + }, + "CognitoGroupConfigurationDetail":{ + "type":"structure", + "members":{ + "groupEntityType":{ + "shape":"GroupEntityType", + "documentation":"The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of an CognitoUserPoolConfigurationDetail structure and is a response parameter to GetIdentitySource.
" + }, + "CognitoGroupConfigurationItem":{ + "type":"structure", + "members":{ + "groupEntityType":{ + "shape":"GroupEntityType", + "documentation":"The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of an CognitoUserPoolConfigurationItem structure and is a response parameter to ListIdentitySources.
" + }, "CognitoUserPoolConfiguration":{ "type":"structure", "required":["userPoolArn"], @@ -663,9 +694,13 @@ "clientIds":{ "shape":"ClientIds", "documentation":"The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: \"ClientIds\": [\"&ExampleCogClientId;\"]
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } }, - "documentation":"The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an Configuration structure that is used as a parameter to CreateIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an Configuration structure that is used as a parameter to CreateIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"issuer\": \"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5\"
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } }, - "documentation":"The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an ConfigurationDetail structure that is part of the response to GetIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an ConfigurationDetail structure that is part of the response to GetIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"issuer\": \"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5\"
The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } }, - "documentation":"The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of the ConfigurationItem structure that is part of the response to ListIdentitySources.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of the ConfigurationItem structure that is part of the response to ListIdentitySources.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration information used when creating a new identity source.
At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.
You must specify a userPoolArn, and optionally, a ClientId.
This data type is used as a request parameter for the CreateIdentitySource operation.
", + "documentation":"Contains configuration information used when creating a new identity source.
At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.
Specifies a userPoolArn, a groupConfiguration, and a ClientId.
This data type is used as a request parameter for the CreateIdentitySource operation.
", "union":true }, "ConfigurationDetail":{ @@ -729,7 +772,7 @@ "members":{ "cognitoUserPoolConfiguration":{ "shape":"CognitoUserPoolConfigurationDetail", - "documentation":"Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration information about an identity source.
This data type is a response parameter to the GetIdentitySource operation.
", @@ -740,7 +783,7 @@ "members":{ "cognitoUserPoolConfiguration":{ "shape":"CognitoUserPoolConfigurationItem", - "documentation":"Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration information about an identity source.
This data type is a response parameter to the ListIdentitySources operation.
", @@ -1464,6 +1507,13 @@ } } }, + "GroupEntityType":{ + "type":"string", + "max":200, + "min":1, + "pattern":"([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*", + "sensitive":true + }, "IdempotencyToken":{ "type":"string", "max":64, @@ -1719,6 +1769,10 @@ "errors":{ "shape":"EvaluationErrorList", "documentation":"Errors that occurred while making an authorization decision. For example, a policy references an entity or entity attribute that does not exist in the slice.
" + }, + "principal":{ + "shape":"EntityIdentifier", + "documentation":"The identifier of the principal in the ID or access token.
" } } }, @@ -1753,7 +1807,6 @@ "ListIdentitySourcesMaxResults":{ "type":"integer", "box":true, - "max":200, "min":1 }, "ListIdentitySourcesOutput":{ @@ -1873,7 +1926,6 @@ "MaxResults":{ "type":"integer", "box":true, - "max":50, "min":1 }, "Namespace":{ @@ -2435,6 +2487,17 @@ "pattern":"[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+", "sensitive":true }, + "UpdateCognitoGroupConfiguration":{ + "type":"structure", + "required":["groupEntityType"], + "members":{ + "groupEntityType":{ + "shape":"GroupEntityType", + "documentation":"The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
The user group entities from an Amazon Cognito user pool identity source.
" + }, "UpdateCognitoUserPoolConfiguration":{ "type":"structure", "required":["userPoolArn"], @@ -2446,6 +2509,10 @@ "clientIds":{ "shape":"ClientIds", "documentation":"The client ID of an app client that is configured for the specified Amazon Cognito user pool.
" + }, + "groupConfiguration":{ + "shape":"UpdateCognitoGroupConfiguration", + "documentation":"The configuration of the user groups from an Amazon Cognito user pool identity source.
" } }, "documentation":"Contains configuration details of a Amazon Cognito user pool for use with an identity source.
" diff --git a/docs/source/conf.py b/docs/source/conf.py index 40470bb99d..6f3fa799b4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.' # The full version, including alpha/beta/rc tags. -release = '1.34.77' +release = '1.34.78' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.