The name of the Auto Scaling group.
", "smithy.api#required": {} } + }, + "WaitForTransitioningInstances": { + "target": "com.amazonaws.autoscaling#BooleanType", + "traits": { + "smithy.api#documentation": "When cancelling an instance refresh, this indicates whether to wait for in-flight launches \n and terminations to complete. The default is true.
\nWhen set to false, Amazon EC2 Auto Scaling cancels the instance refresh \n without waiting for any pending launches or terminations to complete.
" + } } } }, diff --git a/codegen/sdk/aws-models/cloudwatch.json b/codegen/sdk/aws-models/cloudwatch.json index 4aa0d4a854a..2bd481e5937 100644 --- a/codegen/sdk/aws-models/cloudwatch.json +++ b/codegen/sdk/aws-models/cloudwatch.json @@ -95,6 +95,50 @@ } } }, + "com.amazonaws.cloudwatch#AlarmContributor": { + "type": "structure", + "members": { + "ContributorId": { + "target": "com.amazonaws.cloudwatch#ContributorId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique identifier for this alarm contributor.
", + "smithy.api#required": {} + } + }, + "ContributorAttributes": { + "target": "com.amazonaws.cloudwatch#ContributorAttributes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A map of attributes that describe the contributor, such as metric dimensions and other identifying characteristics.
", + "smithy.api#required": {} + } + }, + "StateReason": { + "target": "com.amazonaws.cloudwatch#StateReason", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An explanation for the contributor's current state, providing context about why it is in its current condition.
", + "smithy.api#required": {} + } + }, + "StateTransitionedTimestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the contributor last transitioned to its current state.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an individual contributor to a multi-timeseries alarm, containing information about a specific time series and its contribution to the alarm's state.
" + } + }, + "com.amazonaws.cloudwatch#AlarmContributors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#AlarmContributor" + } + }, "com.amazonaws.cloudwatch#AlarmDescription": { "type": "string", "traits": { @@ -113,6 +157,12 @@ "smithy.api#documentation": "The descriptive name for the alarm.
" } }, + "AlarmContributorId": { + "target": "com.amazonaws.cloudwatch#ContributorId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alarm contributor associated with this history item, if applicable.
" + } + }, "AlarmType": { "target": "com.amazonaws.cloudwatch#AlarmType", "traits": { @@ -142,6 +192,12 @@ "traits": { "smithy.api#documentation": "Data about the alarm, in JSON format.
" } + }, + "AlarmContributorAttributes": { + "target": "com.amazonaws.cloudwatch#ContributorAttributes", + "traits": { + "smithy.api#documentation": "A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.
" + } } }, "traits": { @@ -403,6 +459,24 @@ "target": "com.amazonaws.cloudwatch#AnomalyDetector" } }, + "com.amazonaws.cloudwatch#AttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatch#AttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.cloudwatch#AwsQueryErrorMessage": { "type": "string" }, @@ -617,6 +691,30 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.cloudwatch#ContributorAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatch#AttributeName" + }, + "value": { + "target": "com.amazonaws.cloudwatch#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.cloudwatch#ContributorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.cloudwatch#Counts": { "type": "list", "member": { @@ -1106,6 +1204,70 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatch#DescribeAlarmContributors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatch#DescribeAlarmContributorsInput" + }, + "output": { + "target": "com.amazonaws.cloudwatch#DescribeAlarmContributorsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatch#InvalidNextToken" + }, + { + "target": "com.amazonaws.cloudwatch#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the information of the current alarm contributors that are in ALARM state. This operation returns details about the individual time series that contribute to the alarm's state.
The name of the alarm for which to retrieve contributor information.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", + "traits": { + "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data available.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatch#DescribeAlarmContributorsOutput": { + "type": "structure", + "members": { + "AlarmContributors": { + "target": "com.amazonaws.cloudwatch#AlarmContributors", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of alarm contributors that provide details about the individual time series contributing to the alarm's state.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", + "traits": { + "smithy.api#documentation": "The token that marks the start of the next batch of returned results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudwatch#DescribeAlarmHistory": { "type": "operation", "input": { @@ -1138,6 +1300,12 @@ "smithy.api#documentation": "The name of the alarm.
" } }, + "AlarmContributorId": { + "target": "com.amazonaws.cloudwatch#ContributorId", + "traits": { + "smithy.api#documentation": "The unique identifier of a specific alarm contributor to filter the alarm history results.
" + } + }, "AlarmTypes": { "target": "com.amazonaws.cloudwatch#AlarmTypes", "traits": { @@ -2621,6 +2789,9 @@ { "target": "com.amazonaws.cloudwatch#DeleteMetricStream" }, + { + "target": "com.amazonaws.cloudwatch#DescribeAlarmContributors" + }, { "target": "com.amazonaws.cloudwatch#DescribeAlarmHistory" }, @@ -3743,6 +3914,18 @@ "traits": { "smithy.api#enumValue": "Action" } + }, + "AlarmContributorStateUpdate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AlarmContributorStateUpdate" + } + }, + "AlarmContributorAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AlarmContributorAction" + } } } }, @@ -5854,7 +6037,7 @@ "ApplyOnTransformedLogs": { "target": "com.amazonaws.cloudwatch#InsightRuleOnTransformedLogs", "traits": { - "smithy.api#documentation": "Specify true to have this rule evalute log events after they have been transformed by \n Log transformation. If you specify true, then the log events in log groups that have transformers will \n be evaluated by Contributor Insights after being transformed. Log groups that don't have\n transformers will still have their original log events evaluated by Contributor Insights.
The default is false\n
If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by\n Contributor Insights. For information about investigating log transformation failures, see\n Transformation metrics and errors.
\nSpecify true to have this rule evaluate log events after they have been transformed by \n Log transformation. If you specify true, then the log events in log groups that have transformers will \n be evaluated by Contributor Insights after being transformed. Log groups that don't have\n transformers will still have their original log events evaluated by Contributor Insights.
The default is false\n
If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by\n Contributor Insights. For information about investigating log transformation failures, see\n Transformation metrics and errors.
\nCreates a new predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", + "smithy.api#documentation": "Creates a new predefined attribute for the specified Amazon Connect instance. A predefined\n attribute is made up of a name and a value.
\nFor the predefined attributes per instance quota, see Amazon Connect quotas.
\n\n Use cases\n
\nFollowing are common uses cases for this API:
\nCreate an attribute for routing proficiency (for example, agent certification) that has\n predefined values (for example, a list of possible certifications). For more information, see\n Create\n predefined attributes for routing contacts to agents.
\nCreate an attribute for business unit name that has a list of predefined business unit\n names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see\n Use contact segment attributes.
\n\n Endpoints: See Amazon Connect endpoints and\n quotas.
", "smithy.api#http": { "method": "PUT", "uri": "/predefined-attributes/{InstanceId}", @@ -9032,8 +9035,19 @@ "Values": { "target": "com.amazonaws.connect#PredefinedAttributeValues", "traits": { - "smithy.api#documentation": "The values of the predefined attribute.
", - "smithy.api#required": {} + "smithy.api#documentation": "The values of the predefined attribute.
" + } + }, + "Purposes": { + "target": "com.amazonaws.connect#PredefinedAttributePurposeNameList", + "traits": { + "smithy.api#documentation": "Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.
" + } + }, + "AttributeConfiguration": { + "target": "com.amazonaws.connect#InputPredefinedAttributeConfiguration", + "traits": { + "smithy.api#documentation": "Custom metadata that is associated to predefined attributes to control behavior \nin upstream services, such as controlling \nhow a predefined attribute should be displayed in the Amazon Connect admin website.
" } } }, @@ -14175,7 +14189,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes a predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", + "smithy.api#documentation": "Describes a predefined attribute for the specified Amazon Connect instance. A predefined\n attribute is made up of a name and a value. You can use predefined attributes for:
\nRouting proficiency (for example, agent certification) that has\n predefined values (for example, a list of possible certifications). For more information, see\n Create\n predefined attributes for routing contacts to agents.
\nContact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see\n Use contact segment attributes.
\nFor the predefined attributes per instance quota, see Amazon Connect quotas.
\n\n Endpoints: See Amazon Connect endpoints and\n quotas.
", "smithy.api#http": { "method": "GET", "uri": "/predefined-attributes/{InstanceId}/{Name}", @@ -16713,6 +16727,12 @@ "smithy.api#documentation": "An empty value.
" } }, + "com.amazonaws.connect#EnableValueValidationOnAssociation": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.connect#EncryptionConfig": { "type": "structure", "members": { @@ -21644,6 +21664,21 @@ "target": "com.amazonaws.connect#ContactInitiationMethod" } }, + "com.amazonaws.connect#InputPredefinedAttributeConfiguration": { + "type": "structure", + "members": { + "EnableValueValidationOnAssociation": { + "target": "com.amazonaws.connect#EnableValueValidationOnAssociation", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When this parameter is set to true, Amazon Connect enforces strict validation on the\n specific values, if the values are predefined in attributes. The contact will store only valid\n and predefined values for the predefined attribute key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Custom metadata that is associated to predefined attributes to control behavior in upstream\n services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
" + } + }, "com.amazonaws.connect#Instance": { "type": "structure", "members": { @@ -22486,6 +22521,12 @@ "target": "com.amazonaws.connect#IpCidr" } }, + "com.amazonaws.connect#IsReadOnly": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.connect#IvrRecordingTrack": { "type": "enum", "members": { @@ -25305,7 +25346,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists predefined attributes for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", + "smithy.api#documentation": "Lists predefined attributes for the specified Amazon Connect instance. A predefined\n attribute is made up of a name and a value. You can use predefined attributes for:
\nRouting proficiency (for example, agent certification) that has\n predefined values (for example, a list of possible certifications). For more information, see\n Create\n predefined attributes for routing contacts to agents.
\nContact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see\n Use contact segment attributes.
\nFor the predefined attributes per instance quota, see Amazon Connect quotas.
\n\n Endpoints: See Amazon Connect endpoints and\n quotas.
", "smithy.api#http": { "method": "GET", "uri": "/predefined-attributes/{InstanceId}", @@ -30957,6 +30998,18 @@ "smithy.api#documentation": "The values of the predefined attribute.
" } }, + "Purposes": { + "target": "com.amazonaws.connect#PredefinedAttributePurposeNameList", + "traits": { + "smithy.api#documentation": "Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.
" + } + }, + "AttributeConfiguration": { + "target": "com.amazonaws.connect#PredefinedAttributeConfiguration", + "traits": { + "smithy.api#documentation": "Custom metadata that is associated to predefined attributes to control behavior \nin upstream services, such as controlling \nhow a predefined attribute should be displayed in the Amazon Connect admin website.
" + } + }, "LastModifiedTime": { "target": "com.amazonaws.connect#Timestamp", "traits": { @@ -30974,12 +31027,55 @@ "smithy.api#documentation": "Information about a predefined attribute.
" } }, + "com.amazonaws.connect#PredefinedAttributeConfiguration": { + "type": "structure", + "members": { + "EnableValueValidationOnAssociation": { + "target": "com.amazonaws.connect#EnableValueValidationOnAssociation", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When this parameter is set to true, Amazon Connect enforces strict validation on the\n specific values, if the values are predefined in attributes. The contact will store only valid\n and predefined values for teh predefined attribute key.
" + } + }, + "IsReadOnly": { + "target": "com.amazonaws.connect#IsReadOnly", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean flag used to indicate whether a predefined attribute should be displayed in the\n Amazon Connect admin website.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Custom metadata that is associated to predefined attributes to control behavior in upstream\n services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
" + } + }, "com.amazonaws.connect#PredefinedAttributeName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 64 + "max": 100 + } + } + }, + "com.amazonaws.connect#PredefinedAttributePurposeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#PredefinedAttributePurposeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PredefinedAttributePurposeName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 } } }, @@ -31023,7 +31119,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 64 + "max": 100 } } }, @@ -31034,8 +31130,8 @@ }, "traits": { "smithy.api#length": { - "min": 1, - "max": 128 + "min": 0, + "max": 500 } } }, @@ -35764,7 +35860,7 @@ } ], "traits": { - "smithy.api#documentation": "Searches predefined attributes that meet certain criteria. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", + "smithy.api#documentation": "Searches predefined attributes that meet certain criteria. A predefined\n attribute is made up of a name and a value. You can use predefined attributes for:
\nRouting proficiency (for example, agent certification) that has\n predefined values (for example, a list of possible certifications). For more information, see\n Create\n predefined attributes for routing contacts to agents.
\nContact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see\n Use contact segment attributes.
\nFor the predefined attributes per instance quota, see Amazon Connect quotas.
\n\n Endpoints: See Amazon Connect endpoints and\n quotas.
", "smithy.api#http": { "method": "POST", "uri": "/search-predefined-attributes", @@ -37317,6 +37413,18 @@ "traits": { "smithy.api#documentation": "The value of a segment attribute.
" } + }, + "ValueList": { + "target": "com.amazonaws.connect#SegmentAttributeValueList", + "traits": { + "smithy.api#documentation": "The value of a segment attribute. This is only supported for system-defined attributes, not\n for user-defined attributes.
" + } + }, + "ValueArn": { + "target": "com.amazonaws.connect#SegmentAttributeValueString", + "traits": { + "smithy.api#documentation": "The value of a segment attribute that has to be a valid ARN. This is only supported for\n system-defined attributes, not for user-defined attributes.
" + } } }, "traits": { @@ -37326,6 +37434,12 @@ "com.amazonaws.connect#SegmentAttributeValueInteger": { "type": "integer" }, + "com.amazonaws.connect#SegmentAttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SegmentAttributeValue" + } + }, "com.amazonaws.connect#SegmentAttributeValueMap": { "type": "map", "key": { @@ -42370,7 +42484,7 @@ "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "A set of system defined key-value pairs stored on individual contact segments (unique\n contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.\n They can be accessed in flows.
\nAttribute keys can include only alphanumeric, -, and _.
\nThis field can be used to show channel subtype, such as connect:Guide.
Currently Contact Expiry is the only segment attribute which can be updated by using the\n UpdateContact API.
" + "smithy.api#documentation": "A set of system defined key-value pairs stored on individual contact segments (unique\n contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.\n They can be accessed in flows.
\nAttribute keys can include only alphanumeric, -, and _.
\nThis field can be used to show channel subtype, such as connect:Guide.
Contact Expiry, and user-defined attributes (String - String) that are defined in predefined\n attributes, can be updated by using the UpdateContact API.
" } }, "QueueInfo": { @@ -43523,7 +43637,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.
", + "smithy.api#documentation": "Updates a predefined attribute for the specified Amazon Connect instance. A predefined\n attribute is made up of a name and a value.
\nFor the predefined attributes per instance quota, see Amazon Connect quotas.
\n\n Use cases\n
\nFollowing are common uses cases for this API:
\nUpdate routing proficiency (for example, agent certification) that has\n predefined values (for example, a list of possible certifications). For more information, see\n Create\n predefined attributes for routing contacts to agents.
\nUpdate an attribute for business unit name that has a list of predefined business unit\n names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see\n Use contact segment attributes.
\n\n Endpoints: See Amazon Connect endpoints and\n quotas.
", "smithy.api#http": { "method": "POST", "uri": "/predefined-attributes/{InstanceId}/{Name}", @@ -43555,6 +43669,18 @@ "traits": { "smithy.api#documentation": "The values of the predefined attribute.
" } + }, + "Purposes": { + "target": "com.amazonaws.connect#PredefinedAttributePurposeNameList", + "traits": { + "smithy.api#documentation": "Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.
" + } + }, + "AttributeConfiguration": { + "target": "com.amazonaws.connect#InputPredefinedAttributeConfiguration", + "traits": { + "smithy.api#documentation": "Custom metadata that is associated to predefined attributes to control behavior \nin upstream services, such as controlling \nhow a predefined attribute should be displayed in the Amazon Connect admin website.
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/datazone.json b/codegen/sdk/aws-models/datazone.json index c15ab8ea894..dc151f2e7df 100644 --- a/codegen/sdk/aws-models/datazone.json +++ b/codegen/sdk/aws-models/datazone.json @@ -2403,7 +2403,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels the metadata generation run.
", + "smithy.api#documentation": "Cancels the metadata generation run.
Prerequisites:
The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS).
Runs in SUCCEEDED status cannot be cancelled.
User must have access to the run and cancel permissions.
Creates an asset in Amazon DataZone catalog.
", + "smithy.api#documentation": "Creates an asset in Amazon DataZone catalog.
Before creating assets, make sure that the following requirements are met:
--domain-identifier must refer to an existing domain.
--owning-project-identifier must be a valid project within the domain.
Asset type must be created beforehand using create-asset-type, or be a supported system-defined type. For more information, see create-asset-type.
--type-revision (if used) must match a valid revision of the asset type.
Form type must exist and be associated with the asset type. Use create-form-type to define. For more information, see create-form-type.
Form content must include all required fields as per the form schema (e.g., bucketArn).
You must invoke the following pre-requisite commands before invoking this API:
", "smithy.api#http": { "code": 201, "method": "POST", @@ -3477,7 +3477,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a data asset filter.
", + "smithy.api#documentation": "Creates a data asset filter.
Asset filters provide a sophisticated way to create controlled views of data assets by selecting specific columns or applying row-level filters. This capability is crucial for organizations that need to share data while maintaining security and privacy controls. For example, your database might be filtered to show only non-PII fields to certain users, or sales data might be filtered by region for different regional teams. Asset filters enable fine-grained access control while maintaining a single source of truth.
Prerequisites:
A valid domain (--domain-identifier) must exist.
A data asset (--asset-identifier) must already be created under that domain.
The asset must have the referenced columns available in its schema for column-based filtering.
You cannot specify both (columnConfiguration, rowConfiguration)at the same time.
Creates a revision of the asset.
", + "smithy.api#documentation": "Creates a revision of the asset.
Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary.
Prerequisites:
Asset must already exist in the domain with identifier.
The form type with correct revision must be registered in the same domain.
The form content must include all required fields (e.g., bucketArn for S3ObjectCollectionForm).
The owning project of the original asset must still exist and be active.
User must have write access to the project and domain.
Creates a custom asset type.
", + "smithy.api#documentation": "Creates a custom asset type.
Prerequisites:
The form type with typeIdentifier and typeRevision must exist and be published.
You must have CreateAssetType permissions.
The domain-identifier and owning-project-identifier must be valid and active.
The name of the asset type must be unique within the domain — duplicate names will cause failure.
JSON input must be valid — incorrect formatting causes Invalid JSON errors.
Creates a data product.
", + "smithy.api#documentation": "Creates a data product.
A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It's designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance.
Prerequisites:
The domain must exist and be accessible.
The owning project must be valid and active.
The name must be unique within the domain (no existing data product with the same name).
User must have create permissions for data products in the project.
The domain must have Amazon DataZone publishing enabled.
Creates a data product revision.
", + "smithy.api#documentation": "Creates a data product revision.
Prerequisites:
The original data product must exist in the given domain.
User must have permissions on the data product.
The domain must be valid and accessible.
The new revision name must comply with naming constraints (if required).
Creates a Amazon DataZone blueprint.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprints" + } + } + }, + "com.amazonaws.datazone#CreateEnvironmentBlueprintInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the domain in which this blueprint is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintName", + "traits": { + "smithy.api#documentation": "The name of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of the Amazon DataZone blueprint.
" + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "The provisioning properties of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "The user parameters of this Amazon DataZone blueprint.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateEnvironmentBlueprintOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintName", + "traits": { + "smithy.api#documentation": "The name of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "The description of this Amazon DataZone blueprint.
" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The provider of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "The provisioning properties of this Amazon DataZone blueprint.
", + "smithy.api#required": {} + } + }, + "deploymentProperties": { + "target": "com.amazonaws.datazone#DeploymentProperties", + "traits": { + "smithy.api#documentation": "The deployment properties of this Amazon DataZone blueprint.
" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "The user parameters of this Amazon DataZone blueprint.
" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "The glossary terms attached to this Amazon DataZone blueprint.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the environment blueprint was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when this blueprint was updated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#CreateEnvironmentInput": { "type": "structure", "members": { @@ -6114,7 +6270,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a metadata form type.
", + "smithy.api#documentation": "Creates a metadata form type.
Prerequisites:
The domain must exist and be in an ENABLED state.
The owning project must exist and be accessible.
The name must be unique within the domain.
Creates an Amazon DataZone business glossary.
", + "smithy.api#documentation": "Creates an Amazon DataZone business glossary.
Specifies that this is a create glossary policy.
A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.
Prerequisites:
Domain must exist and be in an active state.
Owning project must exist and be accessible by the caller.
The glossary name must be unique within the domain.
Creates a business glossary term.
", + "smithy.api#documentation": "Creates a business glossary term.
A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.
Prerequisites:
Domain must exist.
Glossary must exist and be in an ENABLED state.
The term name must be unique within the glossary.
Ensure term does not conflict with existing terms in hierarchy.
Specifies whether the custom parameter is optional.
" } + }, + "isUpdateSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether a parameter value can be updated after creation.
" + } } }, "traits": { @@ -9531,6 +9693,9 @@ { "target": "com.amazonaws.datazone#CreateEnvironmentAction" }, + { + "target": "com.amazonaws.datazone#CreateEnvironmentBlueprint" + }, { "target": "com.amazonaws.datazone#CreateEnvironmentProfile" }, @@ -9576,6 +9741,9 @@ { "target": "com.amazonaws.datazone#DeleteEnvironmentAction" }, + { + "target": "com.amazonaws.datazone#DeleteEnvironmentBlueprint" + }, { "target": "com.amazonaws.datazone#DeleteEnvironmentProfile" }, @@ -9804,6 +9972,9 @@ { "target": "com.amazonaws.datazone#UpdateEnvironmentAction" }, + { + "target": "com.amazonaws.datazone#UpdateEnvironmentBlueprint" + }, { "target": "com.amazonaws.datazone#UpdateEnvironmentProfile" }, @@ -10419,7 +10590,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an asset in Amazon DataZone.
", + "smithy.api#documentation": "Deletes an asset in Amazon DataZone.
--domain-identifier must refer to a valid and existing domain.
--identifier must refer to an existing asset in the specified domain.
Asset must not be referenced in any existing asset filters.
Asset must not be linked to any draft or published data product.
User must have delete permissions for the domain and project.
Deletes an asset filter.
", + "smithy.api#documentation": "Deletes an asset filter.
Prerequisites:
The asset filter must exist.
The domain and asset must not have been deleted.
Ensure the --identifier refers to a valid filter ID.
Deletes an asset type in Amazon DataZone.
", + "smithy.api#documentation": "Deletes an asset type in Amazon DataZone.
Prerequisites:
The asset type must exist in the domain.
You must have DeleteAssetType permission.
The asset type must not be in use (e.g., assigned to any asset). If used, deletion will fail.
You should retrieve the asset type using get-asset-type to confirm its presence before deletion.
Deletes a data product in Amazon DataZone.
", + "smithy.api#documentation": "Deletes a data product in Amazon DataZone.
Prerequisites:
The data product must exist and not be deleted or archived.
The user must have delete permissions for the data product.
Ensure there are no active dependencies (e.g., published links, assets using the product).
Domain and project must be active.
Deletes a blueprint in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprints/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, "com.amazonaws.datazone#DeleteEnvironmentBlueprintConfiguration": { "type": "operation", "input": { @@ -11297,6 +11506,30 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#DeleteEnvironmentBlueprintInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the blueprint is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The ID of the blueprint that is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.datazone#DeleteEnvironmentInput": { "type": "structure", "members": { @@ -11409,7 +11642,7 @@ } ], "traits": { - "smithy.api#documentation": "Delets and metadata form type in Amazon DataZone.
", + "smithy.api#documentation": "Deletes and metadata form type in Amazon DataZone.
Prerequisites:
The form type must exist in the domain.
The form type must not be in use by any asset types or assets.
The domain must be valid and accessible.
User must have delete permissions on the form type.
Any dependencies (such as linked asset types) must be removed first.
Deletes a business glossary in Amazon DataZone.
", + "smithy.api#documentation": "Deletes a business glossary in Amazon DataZone.
Prerequisites:
The glossary must be in DISABLED state.
The glossary must not have any glossary terms associated with it.
The glossary must exist in the specified domain.
The caller must have the datazone:DeleteGlossary permission in the domain and glossary.
There should be no active assets or metadata linked to the glossary.
Deletes a business glossary term in Amazon DataZone.
", + "smithy.api#documentation": "Deletes a business glossary term in Amazon DataZone.
Prerequisites:
Glossary term must exist and be active.
The term must not be linked to other assets or child terms.
Caller must have delete permissions in the domain/glossary.
Ensure all associations (such as to assets or parent terms) are removed before deletion.
Gets an Amazon DataZone asset.
", + "smithy.api#documentation": "Gets an Amazon DataZone asset.
An asset is the fundamental building block in Amazon DataZone, representing any data resource that needs to be cataloged and managed. It can take many forms, from Amazon S3 buckets and database tables to dashboards and machine learning models. Each asset contains comprehensive metadata about the resource, including its location, schema, ownership, and lineage information. Assets are essential for organizing and managing data resources across an organization, making them discoverable and usable while maintaining proper governance.
Before using the Amazon DataZone GetAsset command, ensure the following prerequisites are met:
Domain identifier must exist and be valid
Asset identifier must exist
User must have the required permissions to perform the action
Gets an asset filter.
", + "smithy.api#documentation": "Gets an asset filter.
Prerequisites:
Domain (--domain-identifier), asset (--asset-identifier), and filter (--identifier) must all exist.
The asset filter should not have been deleted.
The asset must still exist (since the filter is linked to it).
Gets an Amazon DataZone asset type.
", + "smithy.api#documentation": "Gets an Amazon DataZone asset type.
Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other Amazon Web Services services. Asset types can range from built-in types like Amazon S3 buckets and Amazon Web Services Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial for properly organizing and managing different kinds of data resources.
Prerequisites:
The asset type with identifier must exist in the domain. ResourceNotFoundException.
You must have the GetAssetType permission.
Ensure the domain-identifier value is correct and accessible.
Gets the data product.
", + "smithy.api#documentation": "Gets the data product.
Prerequisites:
The data product ID must exist.
The domain must be valid and accessible.
User must have read or discovery permissions for the data product.
Gets a metadata form type in Amazon DataZone.
", + "smithy.api#documentation": "Gets a metadata form type in Amazon DataZone.
Form types define the structure and validation rules for collecting metadata about assets in Amazon DataZone. They act as templates that ensure consistent metadata capture across similar types of assets, while allowing for customization to meet specific organizational needs. Form types can include required fields, validation rules, and dependencies, helping maintain high-quality metadata that makes data assets more discoverable and usable.
The form type with the specified identifier must exist in the given domain.
The domain must be valid and active.
User must have permission on the form type.
The form type should not be deleted or in an invalid state.
Gets a business glossary in Amazon DataZone.
", + "smithy.api#documentation": "Gets a business glossary in Amazon DataZone.
Prerequisites:
The specified glossary ID must exist and be associated with the given domain.
The caller must have the datazone:GetGlossary permission on the domain.
Gets a business glossary term in Amazon DataZone.
", + "smithy.api#documentation": "Gets a business glossary term in Amazon DataZone.
Prerequisites:
Glossary term with identifier must exist in the domain.
User must have permission on the glossary term.
Domain must be accessible and active.
Gets a metadata generation run in Amazon DataZone.
", + "smithy.api#documentation": "Gets a metadata generation run in Amazon DataZone.
Prerequisites:
Valid domain and run identifier.
The metadata generation run must exist.
User must have read access to the metadata run.
Lists asset filters.
", + "smithy.api#documentation": "Lists asset filters.
Prerequisites:
A valid domain and asset must exist.
The asset must have at least one filter created to return results.
Lists the revisions for the asset.
", + "smithy.api#documentation": "Lists the revisions for the asset.
Prerequisites:
The asset must exist in the domain.
There must be at least one revision of the asset (which happens automatically after creation).
The domain must be valid and active.
User must have permissions on the asset and domain.
Lists data product revisions.
", + "smithy.api#documentation": "Lists data product revisions.
Prerequisites:
The data product ID must exist within the domain.
User must have view permissions on the data product.
The domain must be in a valid and accessible state.
Lists all metadata generation runs.
", + "smithy.api#documentation": "Lists all metadata generation runs.
Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.
Prerequisites:
Valid domain identifier.
User must have access to metadata generation runs in the domain.
Specifies that this is a create glossary policy.
" + "smithy.api#documentation": "Specifies that this is a create glossary policy.
" } }, "createFormType": { @@ -28297,6 +28539,13 @@ "smithy.api#documentation": "The regional parameters in the environment blueprint.
" } }, + "globalParameters": { + "target": "com.amazonaws.datazone#GlobalParameterMap", + "traits": { + "smithy.api#documentation": "Region-agnostic environment blueprint parameters.
", + "smithy.api#notProperty": {} + } + }, "provisioningConfigurations": { "target": "com.amazonaws.datazone#ProvisioningConfigurationList", "traits": { @@ -30425,7 +30674,7 @@ } ], "traits": { - "smithy.api#documentation": "Searches for assets in Amazon DataZone.
", + "smithy.api#documentation": "Searches for assets in Amazon DataZone.
Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.
Many search commands in Amazon DataZone are paginated, including search and search-types. When the result set is large, Amazon DataZone returns a nextToken in the response. This token can be used to retrieve the next page of results.
Prerequisites:
The --domain-identifier must refer to an existing Amazon DataZone domain.
--search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.
The user must have search permissions in the specified domain.
If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys.
For paginated results, be prepared to use --next-token to fetch additional pages.
Searches for types in Amazon DataZone.
", + "smithy.api#documentation": "Searches for types in Amazon DataZone.
Prerequisites:
The --domain-identifier must refer to an existing Amazon DataZone domain.
--search-scope must be one of the valid values including: ASSET_TYPE, GLOSSARY_TERM_TYPE, DATA_PRODUCT_TYPE.
The --managed flag must be present without a value.
The user must have permissions for form or asset types in the domain.
If using --filters, ensure that the JSON is valid.
Filters contain correct structure (attribute, value, operator).
Starts the metadata generation run.
", + "smithy.api#documentation": "Starts the metadata generation run.
Prerequisites:
Asset must be created and belong to the specified domain and project.
Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).
Asset must have a structured schema with valid rows and columns.
Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES.
The user must have permission to run metadata generation in the domain/project.
The timestampf of when the subscription grant was updated.
", + "smithy.api#documentation": "The timestamp of when the subscription grant was updated.
", "smithy.api#required": {} } }, @@ -34331,7 +34580,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an asset filter.
", + "smithy.api#documentation": "Updates an asset filter.
Prerequisites:
The domain, asset, and asset filter identifier must all exist.
The asset must contain the columns being referenced in the update.
If applying a row filter, ensure the column referenced in the expression exists in the asset schema.
Updates an environment blueprint in Amazon DataZone.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprints/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateEnvironmentBlueprintInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "The identifier of the environment blueprint to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description to be updated as part of the UpdateEnvironmentBlueprint action.
The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.
The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.
The identifier of the blueprint to be updated.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintName", + "traits": { + "smithy.api#documentation": "The name to be updated as part of the UpdateEnvironmentBlueprint action.
The description to be updated as part of the UpdateEnvironmentBlueprint action.
The provider of the blueprint to be udpated.
", + "smithy.api#required": {} + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.
The deployment properties to be updated as part of the UpdateEnvironmentBlueprint action.
The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.
The glossary terms to be updated as part of the UpdateEnvironmentBlueprint action.
The timestamp of when the environment blueprint was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the blueprint was updated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#UpdateEnvironmentInput": { "type": "structure", "members": { @@ -35792,7 +36198,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the business glossary in Amazon DataZone.
", + "smithy.api#documentation": "Updates the business glossary in Amazon DataZone.
Prerequisites:
The glossary must exist in the given domain.
The caller must have the datazone:UpdateGlossary permission to update it.
When updating the name, the new name must be unique within the domain.
The glossary must not be deleted or in a terminal state.
Updates a business glossary term in Amazon DataZone.
", + "smithy.api#documentation": "Updates a business glossary term in Amazon DataZone.
Prerequisites:
Glossary term must exist in the specified domain.
New name must not conflict with existing terms in the same glossary.
User must have permissions on the term.
The term must not be in DELETED status.
Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. The user or role that is making the request must have at least \n one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide. Or, if you're using CDN authorization, you will receive this exception\n if MediaPackage receives a throttling error from Secrets Manager.
", + "smithy.api#documentation": "Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -39,6 +39,12 @@ "traits": { "smithy.api#enumValue": "DATERANGE" } + }, + "SCTE35_ENHANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCTE35_ENHANCED" + } } } }, @@ -343,7 +349,7 @@ "InputType": { "target": "com.amazonaws.mediapackagev2#InputType", "traits": { - "smithy.api#documentation": "The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
\nThe allowed values are:
\n\n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
\n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
A comma-separated list of tag key:value pairs that you define. For example:
\n\n \"Key1\": \"Value1\",\n
\n \"Key2\": \"Value2\"\n
A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\",
\"Key2\": \"Value2\"
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
\nThe allowed values are:
\n\n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
\n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
A comma-separated list of tag key:value pairs that you define. For example:
\n\n \"Key1\": \"Value1\",\n
\n \"Key2\": \"Value2\"\n
A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\",
\"Key2\": \"Value2\"
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
\nThe allowed values are:
\n\n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
\n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
\n\n NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.
For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.
" + "smithy.api#documentation": "The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.
For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.
" } }, "SubtitleConfiguration": { @@ -1403,7 +1409,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
\nIrrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
", + "smithy.api#documentation": "Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
", "smithy.api#range": { "min": 1, "max": 1209600 @@ -1416,7 +1422,7 @@ "UrlEncodeChildManifest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.\n For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.
" + "smithy.api#documentation": "When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.
" } } }, @@ -1464,7 +1470,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
\nIrrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
", + "smithy.api#documentation": "Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
", "smithy.api#range": { "min": 1, "max": 1209600 @@ -1477,7 +1483,7 @@ "UrlEncodeChildManifest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.\n For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.
" + "smithy.api#documentation": "When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.
" } } }, @@ -2384,7 +2390,7 @@ "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "A comma-separated list of tag key:value pairs that you define. For example:
\n\n \"Key1\": \"Value1\",\n
\n \"Key2\": \"Value2\"\n
A comma-separated list of tag key:value pairs that you define. For example:
\"Key1\": \"Value1\",
\"Key2\": \"Value2\"
The mimeType of the resource that's at the font download URL.
For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.
", + "smithy.api#documentation": "The mimeType of the resource that's at the font download URL.
For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.
", "smithy.api#length": { "min": 1, "max": 256 @@ -2867,7 +2873,7 @@ "TtmlProfile": { "target": "com.amazonaws.mediapackagev2#DashTtmlProfile", "traits": { - "smithy.api#documentation": "The profile that MediaPackage uses when signaling subtitles in the manifest. IMSC is the default profile. \n EBU-TT-D produces subtitles that are compliant with the EBU-TT-D TTML profile. \n MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format.
The profile that MediaPackage uses when signaling subtitles in the manifest. IMSC is the default profile. EBU-TT-D produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format.
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
\nThe following example setting causes the service to rotate keys every thirty minutes: 1800\n
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
The following example setting causes the service to rotate keys every thirty minutes: 1800
Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.
\nWhen set to true, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.
Important considerations:
\nThis setting only affects CMAF container formats
\nKey rotation can still be handled through media playlist signaling
\nPSSH and TENC boxes remain unaffected
\nDefault behavior is preserved when this setting is disabled
\nValid values: true | false\n
Default: false\n
Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.
When set to true, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.
Important considerations:
This setting only affects CMAF container formats
Key rotation can still be handled through media playlist signaling
PSSH and TENC boxes remain unaffected
Default behavior is preserved when this setting is disabled
Valid values: true | false
Default: false
A collection of audio encryption presets.
\nValue description:
\nPRESET-AUDIO-1 - Use one content key to encrypt all of the\n audio tracks in your stream.
\nPRESET-AUDIO-2 - Use one content key to encrypt all of the\n stereo audio tracks and one content key to encrypt all of the multichannel\n audio tracks.
\nPRESET-AUDIO-3 - Use one content key to encrypt all of the\n stereo audio tracks, one content key to encrypt all of the multichannel audio\n tracks with 3 to 6 channels, and one content key to encrypt all of the\n multichannel audio tracks with more than 6 channels.
\nSHARED - Use the same content key for all of the audio and\n video tracks in your stream.
\nUNENCRYPTED - Don't encrypt any of the audio tracks in your\n stream.
\nA collection of audio encryption presets.
Value description:
PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
SHARED - Use the same content key for all of the audio and video tracks in your stream.
UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
A collection of video encryption presets.
\nValue description:
\nPRESET-VIDEO-1 - Use one content key to encrypt all of the video\n tracks in your stream.
\nPRESET-VIDEO-2 - Use one content key to encrypt all of the SD\n video tracks and one content key for all HD and higher resolutions video\n tracks.
\nPRESET-VIDEO-3 - Use one content key to encrypt all of the SD\n video tracks, one content key for HD video tracks and one content key for all\n UHD video tracks.
\nPRESET-VIDEO-4 - Use one content key to encrypt all of the SD\n video tracks, one content key for HD video tracks, one content key for all UHD1\n video tracks and one content key for all UHD2 video tracks.
\nPRESET-VIDEO-5 - Use one content key to encrypt all of the SD\n video tracks, one content key for HD1 video tracks, one content key for HD2\n video tracks, one content key for all UHD1 video tracks and one content key for\n all UHD2 video tracks.
\nPRESET-VIDEO-6 - Use one content key to encrypt all of the SD\n video tracks, one content key for HD1 video tracks, one content key for HD2\n video tracks and one content key for all UHD video tracks.
\nPRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1\n video tracks, one content key for HD2 video tracks and one content key for all\n UHD video tracks.
\nPRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1\n video tracks, one content key for HD2 video tracks, one content key for all\n UHD1 video tracks and one content key for all UHD2 video tracks.
\nSHARED - Use the same content key for all of the video and audio\n tracks in your stream.
\nUNENCRYPTED - Don't encrypt any of the video tracks in your stream.
\nA collection of video encryption presets.
Value description:
PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
SHARED - Use the same content key for all of the video and audio tracks in your stream.
UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
The failover conditions for the endpoint. The options are:
\n\n STALE_MANIFEST - The manifest stalled and there are no new segments or parts.
\n INCOMPLETE_MANIFEST - There is a gap in the manifest.
\n MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.
\n SLATE_INPUT - The segments which contain slate content are considered to be missing content.
The failover conditions for the endpoint. The options are:
STALE_MANIFEST - The manifest stalled and there are no new segments or parts.
INCOMPLETE_MANIFEST - There is a gap in the manifest.
MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.
SLATE_INPUT - The segments which contain slate content are considered to be missing content.
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
\nThe allowed values are:
\n\n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
\n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
\n\n NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
" + "smithy.api#documentation": "A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
" } }, "ScteDash": { @@ -4467,7 +4473,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
\nIrrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" + "smithy.api#documentation": "Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" } }, "ScteHls": { @@ -4482,7 +4488,7 @@ "UrlEncodeChildManifest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.\n For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.
" + "smithy.api#documentation": "When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.
" } } }, @@ -4528,7 +4534,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
\nIrrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" + "smithy.api#documentation": "Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" } }, "ScteHls": { @@ -4543,7 +4549,7 @@ "UrlEncodeChildManifest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.\n For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.
" + "smithy.api#documentation": "When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.
" } } }, @@ -4929,7 +4935,7 @@ "CdnAuthConfiguration": { "target": "com.amazonaws.mediapackagev2#CdnAuthConfiguration", "traits": { - "smithy.api#documentation": "The settings for using authorization headers between the MediaPackage endpoint and your CDN.
\nFor information about CDN authorization, see CDN authorization\n in Elemental MediaPackage in the MediaPackage user guide.
" + "smithy.api#documentation": "The settings for using authorization headers between the MediaPackage endpoint and your CDN.
For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide.
" } } }, @@ -7079,7 +7085,7 @@ "CdnAuthConfiguration": { "target": "com.amazonaws.mediapackagev2#CdnAuthConfiguration", "traits": { - "smithy.api#documentation": "The settings for using authorization headers between the MediaPackage endpoint and your CDN.
\nFor information about CDN authorization, see CDN authorization\n in Elemental MediaPackage in the MediaPackage user guide.
" + "smithy.api#documentation": "The settings for using authorization headers between the MediaPackage endpoint and your CDN.
For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide.
" } } }, @@ -7124,7 +7130,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Resets a channel", - "smithy.api#documentation": "Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content.
\nBe sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder.
", + "smithy.api#documentation": "Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content.
Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder.
", "smithy.api#examples": [ { "title": "Reset a Channel", @@ -7237,7 +7243,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to reset an origin endpoint", - "smithy.api#documentation": "Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint.
\nMediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint.
", + "smithy.api#documentation": "Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint.
MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint.
", "smithy.api#examples": [ { "title": "Reset an OriginEndpoint", @@ -7465,7 +7471,7 @@ "AdMarkerDash": { "target": "com.amazonaws.mediapackagev2#AdMarkerDash", "traits": { - "smithy.api#documentation": "Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.
\nValue description:
\n\n Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.
\n XML - The SCTE marker is expressed fully in XML.
Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.
Value description:
Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.
XML - The SCTE marker is expressed fully in XML.
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
\nValue description:
\nDATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
\nAd markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
\nThe following example shows a resource ID: MovieNight20171126093045\n
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
The following example shows a resource ID: MovieNight20171126093045
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
\nValid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess\n
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
\nThe following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection\n
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only resources with certain tag values.\n You can use the TagResource operation with a resource that already has tags. If you specify a new tag\n key for the resource, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
", + "smithy.api#documentation": "Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
", "smithy.api#examples": [ { "title": "Add tags to a resource", @@ -7920,7 +7926,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update a channel in a channel group", - "smithy.api#documentation": "Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.
\nAny edits you make that impact the video output may not be reflected for a few minutes.
", + "smithy.api#documentation": "Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.
Any edits you make that impact the video output may not be reflected for a few minutes.
", "smithy.api#examples": [ { "title": "Updating a Channel", @@ -7993,7 +7999,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update a channel group", - "smithy.api#documentation": "Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.
\nAny edits you make that impact the video output may not be reflected for a few minutes.
", + "smithy.api#documentation": "Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.
Any edits you make that impact the video output may not be reflected for a few minutes.
", "smithy.api#examples": [ { "title": "Updating a Channel Group", @@ -8218,7 +8224,7 @@ "InputType": { "target": "com.amazonaws.mediapackagev2#InputType", "traits": { - "smithy.api#documentation": "The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
\nThe allowed values are:
\n\n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
\n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
The allowed values are:
HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.
\nAny edits you make that impact the video output may not be reflected for a few minutes.
", + "smithy.api#documentation": "Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.
Any edits you make that impact the video output may not be reflected for a few minutes.
", "smithy.api#examples": [ { "title": "Updating an OriginEndpoint", @@ -9450,7 +9456,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023.\n To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to\n migrate your resources from MediaPackage v1 to MediaPackage v2.
\nThe names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information\n added, like \"v2\", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use\n the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.
\nIf you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet,\n see the MediaPackage v1 Live API Reference.
\nThis is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.
\nWe assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.
", + "smithy.api#documentation": "This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2.
The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like \"v2\", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.
If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the MediaPackage v1 Live API Reference.
This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.
We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.
", "smithy.api#title": "AWS Elemental MediaPackage v2", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk/aws-models/organizations.json b/codegen/sdk/aws-models/organizations.json index 1a7c13a0472..426b14a1216 100644 --- a/codegen/sdk/aws-models/organizations.json +++ b/codegen/sdk/aws-models/organizations.json @@ -1614,7 +1614,13 @@ "Status": { "target": "com.amazonaws.organizations#AccountStatus", "traits": { - "smithy.api#documentation": "The status of the account in the organization.
" + "smithy.api#documentation": "The status of the account in the organization.
\nThe Status parameter in the Account object will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.
Each state represents a specific phase in the account lifecycle. Use this information\n to manage account access, automate workflows, or trigger actions based on account state\n changes.
\nFor more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the\n Organizations User Guide.
" } }, "JoinedMethod": { @@ -1743,6 +1749,41 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.organizations#AccountState": { + "type": "enum", + "members": { + "PENDING_ACTIVATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ACTIVATION" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPENDED" + } + }, + "PENDING_CLOSURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CLOSURE" + } + }, + "CLOSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOSED" + } + } + } + }, "com.amazonaws.organizations#AccountStatus": { "type": "enum", "members": { @@ -2090,7 +2131,7 @@ } ], "traits": { - "smithy.api#documentation": "Closes an Amazon Web Services member account within an organization. You can close an account when\n all\n features are enabled . You can't close the management account with this API.\n This is an asynchronous request that Amazon Web Services performs in the background. Because\n CloseAccount operates asynchronously, it can return a successful\n completion message even though account closure might still be in progress. You need to\n wait a few minutes before the account is fully closed. To check the status of the\n request, do one of the following:
Use the AccountId that you sent in the CloseAccount\n request to provide as a parameter to the DescribeAccount\n operation.
While the close account request is in progress, Account status will indicate\n PENDING_CLOSURE. When the close account request completes, the status will\n change to SUSPENDED.
\nCheck the CloudTrail log for the CloseAccountResult event that gets\n published after the account closes successfully. For information on using CloudTrail\n with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.
You can close only 10% of member accounts, between 10 and 1000, within a\n rolling 30 day period. This quota is not bound by a calendar month, but\n starts when you close an account. After you reach this limit, you can't close\n additional accounts. For more information, see Closing a member\n account in your organization and Quotas for\n Organizations in the Organizations User Guide.
\nTo reinstate a closed account, contact Amazon Web Services Support within the 90-day\n grace period while the account is in SUSPENDED status.
\nIf the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud\n (US) account, the CloseAccount request will close both\n accounts. To learn important pre-closure details, see \n Closing an Amazon Web Services GovCloud (US) account in the \n Amazon Web Services GovCloud User Guide.
Closes an Amazon Web Services member account within an organization. You can close an account when\n all\n features are enabled . You can't close the management account with this API.\n This is an asynchronous request that Amazon Web Services performs in the background. Because\n CloseAccount operates asynchronously, it can return a successful\n completion message even though account closure might still be in progress. You need to\n wait a few minutes before the account is fully closed. To check the status of the\n request, do one of the following:
Use the AccountId that you sent in the CloseAccount\n request to provide as a parameter to the DescribeAccount\n operation.
While the close account request is in progress, Account status will indicate\n PENDING_CLOSURE. When the close account request completes, the status will\n change to SUSPENDED.
\nCheck the CloudTrail log for the CloseAccountResult event that gets\n published after the account closes successfully. For information on using CloudTrail\n with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.
You can close only 10% of member accounts, between 10 and 1000, within a\n rolling 30 day period. This quota is not bound by a calendar month, but\n starts when you close an account. After you reach this limit, you can't\n close additional accounts. For more information, see Closing a member\n account in your organization and Quotas for\n Organizations in the Organizations User Guide.
\nTo reinstate a closed account, contact Amazon Web Services Support within the 90-day\n grace period while the account is in SUSPENDED status.
\nIf the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud\n (US) account, the CloseAccount request will close both\n accounts. To learn important pre-closure details, see \n Closing an Amazon Web Services GovCloud (US) account in the \n Amazon Web Services GovCloud User Guide.
Creates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:
Use the Id value of the CreateAccountStatus response\n element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the CloudTrail log for the CreateAccountResult event. For\n information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.
The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.
If the request includes tags, then the requester must have the\n organizations:TagResource permission.
Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.
This operation can be called only from the organization's management account.
\nFor more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.
\nWhen you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate\n as a standalone account, such as a payment method is not automatically\n collected. If you must remove an account from your organization later, you\n can do so only after you provide the missing information. For more\n information, see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nIf you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.
\nIf you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.
\nIt isn't recommended to use CreateAccount to create multiple temporary accounts, and using \n the CreateAccount API to close accounts is subject to a 30-day usage quota. For information on the requirements\n and process for closing an account, see Closing a member\n account in your organization in the\n Organizations User Guide.
When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting access to\n your billing information and tools.
\nCreates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:
Use the Id value of the CreateAccountStatus response\n element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the CloudTrail log for the CreateAccountResult event. For\n information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.
The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.
If the request includes tags, then the requester must have the\n organizations:TagResource permission.
Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.
This operation can be called only from the organization's management account.
\nFor more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.
\nWhen you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate\n as a standalone account, such as a payment method is\n not automatically collected. If you must remove an\n account from your organization later, you can do so only after you provide\n the missing information. For more information, see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nIf you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.
\nIf you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.
\nIt isn't recommended to use CreateAccount to create multiple\n temporary accounts, and using the CreateAccount API to close\n accounts is subject to a 30-day usage quota. For information on the\n requirements and process for closing an account, see Closing a member\n account in your organization in the\n Organizations User Guide.
When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting access to\n your billing information and tools.
\nA structure that contains information about the requested account.
" + "smithy.api#documentation": "A structure that contains information about the requested account.
\nThe Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.
Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the\n account.
\nThis operation applies only to management policies. It does not apply to authorization policies: service\n control policies (SCPs) and resource control policies (RCPs).
\nFor more information about policy inheritance, see Understanding\n management policy inheritance in the\n Organizations User Guide.
\nThis operation can be called from any account in the organization.
" + "smithy.api#documentation": "Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the\n account.
\nThis operation applies only to management policies. It does not apply to authorization\n policies: service control policies (SCPs) and resource control policies (RCPs).
\nFor more information about policy inheritance, see Understanding\n management policy inheritance in the\n Organizations User Guide.
\nThis operation can be called from any account in the organization.
" } }, "com.amazonaws.organizations#DescribeEffectivePolicyRequest": { @@ -4006,7 +4047,7 @@ "Organization": { "target": "com.amazonaws.organizations#Organization", "traits": { - "smithy.api#documentation": "A structure that contains information about the organization.
\nThe AvailablePolicyTypes part of the response is deprecated, and you\n shouldn't use it in your apps. It doesn't include any policy type supported by Organizations\n other than SCPs. In the China (Ningxia) Region, no policy type is included.\n To determine which policy types are enabled in your organization,\n use the \n ListRoots\n operation.
A structure that contains information about the organization.
\nThe AvailablePolicyTypes part of the response is deprecated, and you\n shouldn't use it in your apps. It doesn't include any policy type supported by Organizations\n other than SCPs. In the China (Ningxia) Region, no policy type is included. To\n determine which policy types are enabled in your organization, use the \n ListRoots\n operation.
Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.
\nThis is an asynchronous request that Amazon Web Services performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.
\nTo view the status of available policy types in the organization, use DescribeOrganization.
", + "smithy.api#documentation": "Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.
\nThis is an asynchronous request that Amazon Web Services performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.
\nTo view the status of available policy types in the organization, use ListRoots.
", "smithy.api#examples": [ { "title": "To disable a policy type in a root", @@ -4631,7 +4672,7 @@ "ErrorCode": { "target": "com.amazonaws.organizations#ErrorCode", "traits": { - "smithy.api#documentation": "The error code for the validation error. For example, ELEMENTS_TOO_MANY.
The error code for the validation error. For example,\n ELEMENTS_TOO_MANY.
The individual policies inherited and attached to the account which contributed to the validation error.
" + "smithy.api#documentation": "The individual policies inherited and attached to\n the account which contributed to the validation error.
" } } }, "traits": { - "smithy.api#documentation": "Contains details about the\n validation errors that occurred when generating or enforcing an effective policy, such as which policies contributed to the error and location of the error.
" + "smithy.api#documentation": "Contains details about the validation errors that occurred when generating or\n enforcing an effective\n policy, such as which policies contributed to the error and location of the\n error.
" } }, "com.amazonaws.organizations#EffectivePolicyValidationErrors": { @@ -4709,7 +4750,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with permissions to view the structure of an organization, \n create a service-linked role in all the accounts in the organization,\n and allow the service to perform operations\n on behalf of the organization and its accounts. Establishing these permissions can be a first step\n in enabling the integration of an Amazon Web Services service with Organizations.
We recommend that you enable integration between Organizations and the specified Amazon Web Services\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.
\nFor more information about enabling services to integrate with Organizations, see Using\n Organizations with other Amazon Web Services services in the\n Organizations User Guide.
\nThis operation can be called only from the organization's management account.
" + "smithy.api#documentation": "Provides an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with permissions to view the structure of an\n organization, create a service-linked role in\n all the accounts in the organization, and allow the service to perform operations on\n behalf of the organization and its accounts. Establishing these permissions can be a\n first step in enabling the integration of an Amazon Web Services service with Organizations.
We recommend that you enable integration between Organizations and the specified Amazon Web Services\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.
\nFor more information about enabling services to integrate with Organizations, see Using\n Organizations with other Amazon Web Services services in the\n Organizations User Guide.
\nThis operation can be called only from the organization's management account.
" } }, "com.amazonaws.organizations#EnableAWSServiceAccessRequest": { @@ -4861,7 +4902,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.
\nThis is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.
\nYou can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n DescribeOrganization.
", + "smithy.api#documentation": "Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.
\nThis is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.
\nYou can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n ListRoots.
", "smithy.api#examples": [ { "title": "To enable a policy type in a root", @@ -5665,7 +5706,7 @@ } ], "traits": { - "smithy.api#documentation": "Sends an invitation to another account to join your organization as a member account.\n Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.
\nIf you receive an exception that indicates that you exceeded your account\n limits for the organization or that the operation failed because your\n organization is still initializing, wait one hour and then try again. If the\n error persists after an hour, contact Amazon Web Services Support.
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission.
This operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Sends an invitation to another account to join your organization as a member account.\n Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.
\nIf you receive an exception that indicates that you exceeded your account limits\n for the organization or that the operation failed because your organization is still\n initializing, wait one hour and then try again. If the error persists after an hour,\n contact Amazon Web Services\n Support.
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission.
This operation can be called only from the organization's management account.
", "smithy.api#examples": [ { "title": "To invite an account to join an organization", @@ -5804,7 +5845,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the management account, use RemoveAccountFromOrganization\n instead.
\nThis operation can be called only from a member account in the organization.
\nThe management account in an organization with all features enabled can\n set service control policies (SCPs) that can restrict what administrators of\n member accounts can do. This includes preventing them from successfully\n calling LeaveOrganization and leaving the organization.
You can leave an organization as a member account only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For each account that\n you want to make standalone, you must perform the following steps. If any of\n the steps are already completed for this account, that step doesn't\n appear.
\nChoose a support plan
\nProvide and verify the required contact information
\nProvide a current payment method
\nAmazon Web Services uses the payment method to charge for any billable (not free tier)\n Amazon Web Services activity that occurs while the account isn't attached to an\n organization. For more information, see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nThe account that you want to leave must not be a delegated administrator\n account for any Amazon Web Services service enabled for your organization. If the account\n is a delegated administrator, you must first change the delegated\n administrator account to another account that is remaining in the\n organization.
\nAfter the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. Amazon Web Services accounts outside\n of an organization do not support tags.
\nA newly created account has a waiting period before it can be removed from\n its organization.\n You must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.
\nIf you are using an organization principal to call\n LeaveOrganization across multiple accounts, you can only do\n this up to 5 accounts per second in a single organization.
Removes a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the management account, use RemoveAccountFromOrganization\n instead.
\nThis operation can be called only from a member account in the organization.
\nThe management account in an organization with all features enabled can\n set service control policies (SCPs) that can restrict what administrators of\n member accounts can do. This includes preventing them from successfully\n calling LeaveOrganization and leaving the organization.
You can leave an organization as a member account only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For each account that\n you want to make standalone, you must perform the following steps. If any of\n the steps are already completed for this account, that step doesn't\n appear.
\nChoose a support plan
\nProvide and verify the required contact information
\nProvide a current payment method
\nAmazon Web Services uses the payment method to charge for any billable (not free tier)\n Amazon Web Services activity that occurs while the account isn't attached to an\n organization. For more information, see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nThe account that you want to leave must not be a delegated administrator\n account for any Amazon Web Services service enabled for your organization. If the account\n is a delegated administrator, you must first change the delegated\n administrator account to another account that is remaining in the\n organization.
\nAfter the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. Amazon Web Services accounts outside\n of an organization do not support tags.
\nA newly created account has a waiting period before it can be removed from\n its organization. You must wait until at least seven days after the account\n was created. Invited accounts aren't subject to this waiting period.
\nIf you are using an organization principal to call\n LeaveOrganization across multiple accounts, you can only do\n this up to 5 accounts per second in a single organization.
A list of the accounts in the specified root or OU.
" + "smithy.api#documentation": "A list of the accounts in the specified root or OU.
\nThe Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.
A list of objects in the organization.
" + "smithy.api#documentation": "A list of objects in the organization.
\nThe Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.
Lists all the accounts in an organization that have invalid effective policies.\n An invalid effective policy is an effective policy that fails validation checks, resulting in the effective policy not being fully enforced on all the intended accounts within an organization.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.
", + "smithy.api#documentation": "Lists all the accounts in an organization that have invalid effective policies. An\n invalid effective policy is an effective\n policy that fails validation checks, resulting in the effective policy not\n being fully enforced on all the intended accounts within an organization.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.
", "smithy.api#examples": [ { "title": "To list all accounts in an organization with invalid effective policy", @@ -6669,7 +6710,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the validation errors on an effective policy for a specified account and policy type.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.
", + "smithy.api#documentation": "Lists all the validation errors on an effective\n policy for a specified account and policy type.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6684,7 +6725,7 @@ "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { - "smithy.api#documentation": "The ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.
", + "smithy.api#documentation": "The ID of the account that you want details about. Specifying an organization root or\n organizational unit (OU) as the target is not supported.
", "smithy.api#required": {} } }, @@ -6724,7 +6765,7 @@ "PolicyType": { "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { - "smithy.api#documentation": "The specified policy type. One of the\n following values:
\n\n BACKUP_POLICY\n
\n\n TAG_POLICY\n
\n\n CHATBOT_POLICY\n
\n\n SECURITYHUB_POLICY\n
\nThe specified policy type. One of the following values:
\n\n BACKUP_POLICY\n
\n\n TAG_POLICY\n
\n\n CHATBOT_POLICY\n
\n\n SECURITYHUB_POLICY\n
\nThe time when the latest effective policy was generated for the specified account.
" + "smithy.api#documentation": "The time when the latest effective policy was generated for the specified\n account.
" } }, "NextToken": { @@ -6748,7 +6789,7 @@ "EffectivePolicyValidationErrors": { "target": "com.amazonaws.organizations#EffectivePolicyValidationErrors", "traits": { - "smithy.api#documentation": "The EffectivePolicyValidationError object contains details about the\n validation errors that occurred when generating or enforcing an effective policy, such as which policies contributed to the error and location of the error.
The EffectivePolicyValidationError object contains details about the\n validation errors that occurred when generating or enforcing an effective policy, such\n as which policies contributed to the error and location of the error.
The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
\nThe regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.
" + "smithy.api#documentation": "The unique identifier (ID) associated with this OU. The ID is unique to the\n organization only.
\nThe regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.
" } }, "Arn": { @@ -8842,7 +8883,7 @@ "Id": { "target": "com.amazonaws.organizations#RootId", "traits": { - "smithy.api#documentation": "The unique identifier (ID) for the root. The ID is unique to the organization only.
\nThe regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.
" + "smithy.api#documentation": "The unique identifier (ID) for the root. The ID is unique to the organization\n only.
\nThe regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.
" } }, "Arn": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index 1ff4e6f8afe..01525c8c9c4 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -1655,6 +1655,12 @@ "smithy.api#enumValue": "ml.p5en.48xlarge" } }, + "ML_P6_B200_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p6-b200.48xlarge" + } + }, "ML_M6I_LARGE": { "target": "smithy.api#Unit", "traits": { @@ -30813,6 +30819,12 @@ "traits": { "smithy.api#documentation": "The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" } + }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#IPAddressType", + "traits": { + "smithy.api#documentation": "The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.
The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" } + }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#IPAddressType", + "traits": { + "smithy.api#documentation": "The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.