Deletes the policy document that manages permissions on a backup vault.
", "idempotent":true }, + "DeleteBackupVaultLockConfiguration":{ + "name":"DeleteBackupVaultLockConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/backup-vaults/{backupVaultName}/vault-lock" + }, + "input":{"shape":"DeleteBackupVaultLockConfigurationInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.
Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
", "idempotent":true }, + "PutBackupVaultLockConfiguration":{ + "name":"PutBackupVaultLockConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/backup-vaults/{backupVaultName}/vault-lock" + }, + "input":{"shape":"PutBackupVaultLockConfigurationInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
", + "idempotent":true + }, "PutBackupVaultNotifications":{ "name":"PutBackupVaultNotifications", "http":{ @@ -1570,6 +1604,22 @@ "NumberOfRecoveryPoints":{ "shape":"long", "documentation":"The number of recovery points that are stored in a backup vault.
" + }, + "Locked":{ + "shape":"Boolean", + "documentation":"A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.
The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
" + }, + "MaxRetentionDays":{ + "shape":"Long", + "documentation":"The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
" + }, + "LockDate":{ + "shape":"timestamp", + "documentation":"The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
" } }, "documentation":"Contains metadata about a backup vault.
" @@ -2072,6 +2122,18 @@ } } }, + "DeleteBackupVaultLockConfigurationInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"The name of the backup vault from which to delete Backup Vault Lock.
", + "location":"uri", + "locationName":"backupVaultName" + } + } + }, "DeleteBackupVaultNotificationsInput":{ "type":"structure", "required":["BackupVaultName"], @@ -2282,6 +2344,22 @@ "NumberOfRecoveryPoints":{ "shape":"long", "documentation":"The number of recovery points that are stored in a backup vault.
" + }, + "Locked":{ + "shape":"Boolean", + "documentation":"A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.
The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
" + }, + "MaxRetentionDays":{ + "shape":"Long", + "documentation":"The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
" + }, + "LockDate":{ + "shape":"timestamp", + "documentation":"The date and time when Backup Vault Lock configuration cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
" } } }, @@ -3823,6 +3901,30 @@ } } }, + "PutBackupVaultLockConfigurationInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"The Backup Vault Lock configuration that specifies the name of the backup vault it protects.
", + "location":"uri", + "locationName":"backupVaultName" + }, + "MinRetentionDays":{ + "shape":"Long", + "documentation":"The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.
" + }, + "MaxRetentionDays":{ + "shape":"Long", + "documentation":"The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).
If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.
" + }, + "ChangeableForDays":{ + "shape":"Long", + "documentation":"The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.
Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays to 3 or greater.
Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.
If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration at any time.
The configuration for the audio artifacts.
" + }, + "Video":{ + "shape":"VideoArtifactsConfiguration", + "documentation":"The configuration for the video artifacts.
" + }, + "Content":{ + "shape":"ContentArtifactsConfiguration", + "documentation":"The configuration for the content artifacts.
" + } + }, + "documentation":"The configuration for the artifacts.
" + }, + "ArtifactsState":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, "AssociatePhoneNumberWithUserRequest":{ "type":"structure", "required":[ @@ -4261,6 +4292,11 @@ }, "documentation":" An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
The MUX type of the audio artifact configuration object.
" + } + }, + "documentation":"The audio artifact configuration object.
" + }, + "AudioMuxType":{ + "type":"string", + "enum":[ + "AudioOnly", + "AudioWithActiveSpeakerVideo" + ] + }, "BadRequestException":{ "type":"structure", "members":{ @@ -5023,6 +5077,20 @@ "min":5, "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" }, + "ChimeSdkMeetingConfiguration":{ + "type":"structure", + "members":{ + "SourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"The source configuration for a specified media capture pipline.
" + }, + "ArtifactsConfiguration":{ + "shape":"ArtifactsConfiguration", + "documentation":"The configuration for the artifacts in an Amazon Chime SDK meeting.
" + } + }, + "documentation":"The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
Indicates whether the content artifact is enabled or disabled.
" + }, + "MuxType":{ + "shape":"ContentMuxType", + "documentation":"The MUX type of the artifact configuration.
" + } + }, + "documentation":"The content artifact object.
" + }, + "ContentMuxType":{ + "type":"string", + "enum":["ContentOnly"] + }, "ConversationRetentionSettings":{ "type":"structure", "members":{ @@ -5505,6 +5592,10 @@ "shape":"ClientRequestToken", "documentation":"The token assigned to the client making the pipeline request.
", "idempotencyToken":true + }, + "ChimeSdkMeetingConfiguration":{ + "shape":"ChimeSdkMeetingConfiguration", + "documentation":"The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
The time at which the capture pipeline was updated, in ISO 8601 format.
" + }, + "ChimeSdkMeetingConfiguration":{ + "shape":"ChimeSdkMeetingConfiguration", + "documentation":"The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.
A media capture pipeline object. A string consisting of an ID, source type, a source ARN, a sink type, and a sink ARN.
" + "documentation":"A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.
" }, "MediaCapturePipelineList":{ "type":"list", @@ -9194,7 +9294,7 @@ }, "EventIngestionUrl":{ "shape":"UriType", - "documentation":"The URL of the S3 bucket used to store the captured media.
" + "documentation":"The event ingestion URL.
" } }, "documentation":"A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
" @@ -10621,6 +10721,20 @@ } } }, + "SelectedVideoStreams":{ + "type":"structure", + "members":{ + "AttendeeIds":{ + "shape":"AttendeeIdList", + "documentation":"The attendee IDs of the streams selected for a media capture pipeline.
" + }, + "ExternalUserIds":{ + "shape":"ExternalUserIdList", + "documentation":"The external user IDs of the streams selected for a media capture pipeline.
" + } + }, + "documentation":"The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.
" + }, "SendChannelMessageRequest":{ "type":"structure", "required":[ @@ -10894,6 +11008,16 @@ "DESCENDING" ] }, + "SourceConfiguration":{ + "type":"structure", + "members":{ + "SelectedVideoStreams":{ + "shape":"SelectedVideoStreams", + "documentation":"The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
" + } + }, + "documentation":"Source configuration for a specified media capture pipeline.
" + }, "StartMeetingTranscriptionRequest":{ "type":"structure", "required":[ @@ -11607,10 +11731,6 @@ }, "UpdateGlobalSettingsRequest":{ "type":"structure", - "required":[ - "BusinessCalling", - "VoiceConnector" - ], "members":{ "BusinessCalling":{ "shape":"BusinessCallingSettings", @@ -12192,6 +12312,25 @@ "SharedDevice" ] }, + "VideoArtifactsConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"ArtifactsState", + "documentation":"Indicates whether the video artifact is enabled or disabled.
" + }, + "MuxType":{ + "shape":"VideoMuxType", + "documentation":"The MUX type of the video artifact configuration object.
" + } + }, + "documentation":"The video artifact configuration object.
" + }, + "VideoMuxType":{ + "type":"string", + "enum":["VideoOnly"] + }, "VoiceConnector":{ "type":"structure", "members":{ diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index b59007d3a3..6573c72cde 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -3596,6 +3596,70 @@ "us-west-2" : { } } }, + "grafana" : { + "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "grafana.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "grafana.ap-northeast-2.amazonaws.com" + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "grafana.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "grafana.ap-southeast-2.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "grafana.eu-central-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "grafana.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "grafana.eu-west-2.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "grafana.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "grafana.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "grafana.us-west-2.amazonaws.com" + } + } + }, "greengrass" : { "defaults" : { "protocols" : [ "https" ] diff --git a/botocore/data/firehose/2015-08-04/service-2.json b/botocore/data/firehose/2015-08-04/service-2.json index 3287621644..d1603e023c 100644 --- a/botocore/data/firehose/2015-08-04/service-2.json +++ b/botocore/data/firehose/2015-08-04/service-2.json @@ -202,6 +202,132 @@ "min":1, "pattern":"arn:.*" }, + "AmazonopensearchserviceBufferingHints":{ + "type":"structure", + "members":{ + "IntervalInSeconds":{"shape":"AmazonopensearchserviceBufferingIntervalInSeconds"}, + "SizeInMBs":{"shape":"AmazonopensearchserviceBufferingSizeInMBs"} + } + }, + "AmazonopensearchserviceBufferingIntervalInSeconds":{ + "type":"integer", + "max":900, + "min":60 + }, + "AmazonopensearchserviceBufferingSizeInMBs":{ + "type":"integer", + "max":100, + "min":1 + }, + "AmazonopensearchserviceClusterEndpoint":{ + "type":"string", + "max":512, + "min":1, + "pattern":"https:.*" + }, + "AmazonopensearchserviceDestinationConfiguration":{ + "type":"structure", + "required":[ + "RoleARN", + "IndexName", + "S3Configuration" + ], + "members":{ + "RoleARN":{"shape":"RoleARN"}, + "DomainARN":{"shape":"AmazonopensearchserviceDomainARN"}, + "ClusterEndpoint":{"shape":"AmazonopensearchserviceClusterEndpoint"}, + "IndexName":{"shape":"AmazonopensearchserviceIndexName"}, + "TypeName":{"shape":"AmazonopensearchserviceTypeName"}, + "IndexRotationPeriod":{"shape":"AmazonopensearchserviceIndexRotationPeriod"}, + "BufferingHints":{"shape":"AmazonopensearchserviceBufferingHints"}, + "RetryOptions":{"shape":"AmazonopensearchserviceRetryOptions"}, + "S3BackupMode":{"shape":"AmazonopensearchserviceS3BackupMode"}, + "S3Configuration":{"shape":"S3DestinationConfiguration"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, + "VpcConfiguration":{"shape":"VpcConfiguration"} + } + }, + "AmazonopensearchserviceDestinationDescription":{ + "type":"structure", + "members":{ + "RoleARN":{"shape":"RoleARN"}, + "DomainARN":{"shape":"AmazonopensearchserviceDomainARN"}, + "ClusterEndpoint":{"shape":"AmazonopensearchserviceClusterEndpoint"}, + "IndexName":{"shape":"AmazonopensearchserviceIndexName"}, + "TypeName":{"shape":"AmazonopensearchserviceTypeName"}, + "IndexRotationPeriod":{"shape":"AmazonopensearchserviceIndexRotationPeriod"}, + "BufferingHints":{"shape":"AmazonopensearchserviceBufferingHints"}, + "RetryOptions":{"shape":"AmazonopensearchserviceRetryOptions"}, + "S3BackupMode":{"shape":"AmazonopensearchserviceS3BackupMode"}, + "S3DestinationDescription":{"shape":"S3DestinationDescription"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, + "VpcConfigurationDescription":{"shape":"VpcConfigurationDescription"} + } + }, + "AmazonopensearchserviceDestinationUpdate":{ + "type":"structure", + "members":{ + "RoleARN":{"shape":"RoleARN"}, + "DomainARN":{"shape":"AmazonopensearchserviceDomainARN"}, + "ClusterEndpoint":{"shape":"AmazonopensearchserviceClusterEndpoint"}, + "IndexName":{"shape":"AmazonopensearchserviceIndexName"}, + "TypeName":{"shape":"AmazonopensearchserviceTypeName"}, + "IndexRotationPeriod":{"shape":"AmazonopensearchserviceIndexRotationPeriod"}, + "BufferingHints":{"shape":"AmazonopensearchserviceBufferingHints"}, + "RetryOptions":{"shape":"AmazonopensearchserviceRetryOptions"}, + "S3Update":{"shape":"S3DestinationUpdate"}, + "ProcessingConfiguration":{"shape":"ProcessingConfiguration"}, + "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"} + } + }, + "AmazonopensearchserviceDomainARN":{ + "type":"string", + "max":512, + "min":1, + "pattern":"arn:.*" + }, + "AmazonopensearchserviceIndexName":{ + "type":"string", + "max":80, + "min":1, + "pattern":".*" + }, + "AmazonopensearchserviceIndexRotationPeriod":{ + "type":"string", + "enum":[ + "NoRotation", + "OneHour", + "OneDay", + "OneWeek", + "OneMonth" + ] + }, + "AmazonopensearchserviceRetryDurationInSeconds":{ + "type":"integer", + "max":7200, + "min":0 + }, + "AmazonopensearchserviceRetryOptions":{ + "type":"structure", + "members":{ + "DurationInSeconds":{"shape":"AmazonopensearchserviceRetryDurationInSeconds"} + } + }, + "AmazonopensearchserviceS3BackupMode":{ + "type":"string", + "enum":[ + "FailedDocumentsOnly", + "AllDocuments" + ] + }, + "AmazonopensearchserviceTypeName":{ + "type":"string", + "max":100, + "min":0, + "pattern":".*" + }, "BlockSizeBytes":{ "type":"integer", "min":67108864 @@ -346,6 +472,7 @@ "shape":"ElasticsearchDestinationConfiguration", "documentation":"The destination in Amazon ES. You can specify only one destination.
" }, + "AmazonopensearchserviceDestinationConfiguration":{"shape":"AmazonopensearchserviceDestinationConfiguration"}, "SplunkDestinationConfiguration":{ "shape":"SplunkDestinationConfiguration", "documentation":"The destination in Splunk. You can specify only one destination.
" @@ -669,6 +796,7 @@ "shape":"ElasticsearchDestinationDescription", "documentation":"The destination in Amazon ES.
" }, + "AmazonopensearchserviceDestinationDescription":{"shape":"AmazonopensearchserviceDestinationDescription"}, "SplunkDestinationDescription":{ "shape":"SplunkDestinationDescription", "documentation":"The destination in Splunk.
" @@ -2811,6 +2939,7 @@ "shape":"ElasticsearchDestinationUpdate", "documentation":"Describes an update for a destination in Amazon ES.
" }, + "AmazonopensearchserviceDestinationUpdate":{"shape":"AmazonopensearchserviceDestinationUpdate"}, "SplunkDestinationUpdate":{ "shape":"SplunkDestinationUpdate", "documentation":"Describes an update for a destination in Splunk.
" diff --git a/botocore/data/grafana/2020-08-18/paginators-1.json b/botocore/data/grafana/2020-08-18/paginators-1.json new file mode 100644 index 0000000000..0edc069328 --- /dev/null +++ b/botocore/data/grafana/2020-08-18/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListPermissions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "permissions" + }, + "ListWorkspaces": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "workspaces" + } + } +} diff --git a/botocore/data/grafana/2020-08-18/service-2.json b/botocore/data/grafana/2020-08-18/service-2.json new file mode 100644 index 0000000000..1bdc083bdd --- /dev/null +++ b/botocore/data/grafana/2020-08-18/service-2.json @@ -0,0 +1,1461 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-08-18", + "endpointPrefix":"grafana", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Managed Grafana", + "serviceId":"grafana", + "signatureVersion":"v4", + "signingName":"grafana", + "uid":"grafana-2020-08-18" + }, + "operations":{ + "AssociateLicense":{ + "name":"AssociateLicense", + "http":{ + "method":"POST", + "requestUri":"/workspaces/{workspaceId}/licenses/{licenseType}", + "responseCode":202 + }, + "input":{"shape":"AssociateLicenseRequest"}, + "output":{"shape":"AssociateLicenseResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.
" + }, + "CreateWorkspace":{ + "name":"CreateWorkspace", + "http":{ + "method":"POST", + "requestUri":"/workspaces", + "responseCode":202 + }, + "input":{"shape":"CreateWorkspaceRequest"}, + "output":{"shape":"CreateWorkspaceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.
Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace.
Deletes an Amazon Managed Grafana workspace.
", + "idempotent":true + }, + "DescribeWorkspace":{ + "name":"DescribeWorkspace", + "http":{ + "method":"GET", + "requestUri":"/workspaces/{workspaceId}", + "responseCode":200 + }, + "input":{"shape":"DescribeWorkspaceRequest"}, + "output":{"shape":"DescribeWorkspaceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Displays information about one Amazon Managed Grafana workspace.
" + }, + "DescribeWorkspaceAuthentication":{ + "name":"DescribeWorkspaceAuthentication", + "http":{ + "method":"GET", + "requestUri":"/workspaces/{workspaceId}/authentication", + "responseCode":200 + }, + "input":{"shape":"DescribeWorkspaceAuthenticationRequest"}, + "output":{"shape":"DescribeWorkspaceAuthenticationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
" + }, + "DisassociateLicense":{ + "name":"DisassociateLicense", + "http":{ + "method":"DELETE", + "requestUri":"/workspaces/{workspaceId}/licenses/{licenseType}", + "responseCode":202 + }, + "input":{"shape":"DisassociateLicenseRequest"}, + "output":{"shape":"DisassociateLicenseResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes the Grafana Enterprise license from a workspace.
" + }, + "ListPermissions":{ + "name":"ListPermissions", + "http":{ + "method":"GET", + "requestUri":"/workspaces/{workspaceId}/permissions", + "responseCode":200 + }, + "input":{"shape":"ListPermissionsRequest"}, + "output":{"shape":"ListPermissionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId, the operation returns the roles of all users and groups. If you specify a userId or a groupId, only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId.
Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.
" + }, + "UpdatePermissions":{ + "name":"UpdatePermissions", + "http":{ + "method":"PATCH", + "requestUri":"/workspaces/{workspaceId}/permissions", + "responseCode":200 + }, + "input":{"shape":"UpdatePermissionsRequest"}, + "output":{"shape":"UpdatePermissionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates which users in a workspace have the Grafana Admin or Editor roles.
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.
To modify the user authentication methods that the workspace uses, such as SAML or Amazon Web Services SSO, use UpdateWorkspaceAuthentication.
To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.
Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.
You do not have sufficient permissions to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountAccessType":{ + "type":"string", + "enum":[ + "CURRENT_ACCOUNT", + "ORGANIZATION" + ] + }, + "AllowedOrganization":{ + "type":"string", + "max":256, + "min":1 + }, + "AllowedOrganizations":{ + "type":"list", + "member":{"shape":"AllowedOrganization"} + }, + "AssertionAttribute":{ + "type":"string", + "max":256, + "min":1 + }, + "AssertionAttributes":{ + "type":"structure", + "members":{ + "email":{ + "shape":"AssertionAttribute", + "documentation":"The name of the attribute within the SAML assertion to use as the email names for SAML users.
" + }, + "groups":{ + "shape":"AssertionAttribute", + "documentation":"The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for user groups.
" + }, + "login":{ + "shape":"AssertionAttribute", + "documentation":"The name of the attribute within the SAML assertion to use as the login names for SAML users.
" + }, + "name":{ + "shape":"AssertionAttribute", + "documentation":"The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for SAML users.
" + }, + "org":{ + "shape":"AssertionAttribute", + "documentation":"The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for the users' organizations.
" + }, + "role":{ + "shape":"AssertionAttribute", + "documentation":"The name of the attribute within the SAML assertion to use as the user roles.
" + } + }, + "documentation":"A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspace.
" + }, + "AssociateLicenseRequest":{ + "type":"structure", + "required":[ + "licenseType", + "workspaceId" + ], + "members":{ + "licenseType":{ + "shape":"LicenseType", + "documentation":"The type of license to associate with the workspace.
", + "location":"uri", + "locationName":"licenseType" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to associate the license with.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "AssociateLicenseResponse":{ + "type":"structure", + "required":["workspace"], + "members":{ + "workspace":{ + "shape":"WorkspaceDescription", + "documentation":"A structure containing data about the workspace.
" + } + } + }, + "AuthenticationDescription":{ + "type":"structure", + "required":["providers"], + "members":{ + "awsSso":{ + "shape":"AwsSsoAuthentication", + "documentation":"A structure containing information about how this workspace works with Amazon Web Services SSO.
" + }, + "providers":{ + "shape":"AuthenticationProviders", + "documentation":"Specifies whether this workspace uses Amazon Web Services SSO, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
" + }, + "saml":{ + "shape":"SamlAuthentication", + "documentation":"A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.
" + } + }, + "documentation":"A structure containing information about the user authentication methods used by the workspace.
" + }, + "AuthenticationProviderTypes":{ + "type":"string", + "enum":[ + "AWS_SSO", + "SAML" + ] + }, + "AuthenticationProviders":{ + "type":"list", + "member":{"shape":"AuthenticationProviderTypes"} + }, + "AuthenticationSummary":{ + "type":"structure", + "required":["providers"], + "members":{ + "providers":{ + "shape":"AuthenticationProviders", + "documentation":"Specifies whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
" + }, + "samlConfigurationStatus":{ + "shape":"SamlConfigurationStatus", + "documentation":"Specifies whether the workplace's user authentication method is fully configured.
" + } + }, + "documentation":"A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication, and whether that authentication is fully configured.
" + }, + "AwsSsoAuthentication":{ + "type":"structure", + "members":{ + "ssoClientId":{ + "shape":"SSOClientId", + "documentation":"The ID of the Amazon Web Services SSO-managed application that is created by Amazon Managed Grafana.
" + } + }, + "documentation":"A structure containing information about how this workspace works with Amazon Web Services SSO.
" + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ClientToken":{ + "type":"string", + "pattern":"^[!-~]{1,64}$" + }, + "ConflictException":{ + "type":"structure", + "required":[ + "message", + "resourceId", + "resourceType" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"A description of the error.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the resource that is associated with the error.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of the resource that is associated with the error.
" + } + }, + "documentation":"A resource was in an inconsistent state during an update or a deletion.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateWorkspaceRequest":{ + "type":"structure", + "required":[ + "accountAccessType", + "authenticationProviders", + "permissionType" + ], + "members":{ + "accountAccessType":{ + "shape":"AccountAccessType", + "documentation":"Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.
Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", + "idempotencyToken":true + }, + "organizationRoleName":{ + "shape":"OrganizationRoleName", + "documentation":"The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
" + }, + "permissionType":{ + "shape":"PermissionType", + "documentation":"If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.
For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
" + }, + "stackSetName":{ + "shape":"StackSetName", + "documentation":"The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
" + }, + "workspaceDataSources":{ + "shape":"DataSourceTypesList", + "documentation":"Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.
If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.
" + }, + "workspaceDescription":{ + "shape":"Description", + "documentation":"A description for the workspace. This is used only to help you identify this workspace.
" + }, + "workspaceName":{ + "shape":"WorkspaceName", + "documentation":"The name for the workspace. It does not have to be unique.
" + }, + "workspaceNotificationDestinations":{ + "shape":"NotificationDestinationsList", + "documentation":"Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
" + }, + "workspaceOrganizationalUnits":{ + "shape":"OrganizationalUnitList", + "documentation":"Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
" + }, + "workspaceRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. If you omit this field and you specify some Amazon Web Services resources in workspaceDataSources or workspaceNotificationDestinations, a new IAM role with the necessary permissions is automatically created.
A structure containing data about the workspace that was created.
" + } + } + }, + "DataSourceType":{ + "type":"string", + "enum":[ + "AMAZON_OPENSEARCH_SERVICE", + "CLOUDWATCH", + "PROMETHEUS", + "XRAY", + "TIMESTREAM", + "SITEWISE" + ] + }, + "DataSourceTypesList":{ + "type":"list", + "member":{"shape":"DataSourceType"} + }, + "DeleteWorkspaceRequest":{ + "type":"structure", + "required":["workspaceId"], + "members":{ + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to delete.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "DeleteWorkspaceResponse":{ + "type":"structure", + "required":["workspace"], + "members":{ + "workspace":{ + "shape":"WorkspaceDescription", + "documentation":"A structure containing information about the workspace that was deleted.
" + } + } + }, + "DescribeWorkspaceAuthenticationRequest":{ + "type":"structure", + "required":["workspaceId"], + "members":{ + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to return authentication information about.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "DescribeWorkspaceAuthenticationResponse":{ + "type":"structure", + "required":["authentication"], + "members":{ + "authentication":{ + "shape":"AuthenticationDescription", + "documentation":"A structure containing information about the authentication methods used in the workspace.
" + } + } + }, + "DescribeWorkspaceRequest":{ + "type":"structure", + "required":["workspaceId"], + "members":{ + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to display information about.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "DescribeWorkspaceResponse":{ + "type":"structure", + "required":["workspace"], + "members":{ + "workspace":{ + "shape":"WorkspaceDescription", + "documentation":"A structure containing information about the workspace.
" + } + } + }, + "Description":{ + "type":"string", + "max":2048, + "min":0, + "sensitive":true + }, + "DisassociateLicenseRequest":{ + "type":"structure", + "required":[ + "licenseType", + "workspaceId" + ], + "members":{ + "licenseType":{ + "shape":"LicenseType", + "documentation":"The type of license to remove from the workspace.
", + "location":"uri", + "locationName":"licenseType" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to remove the Grafana Enterprise license from.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "DisassociateLicenseResponse":{ + "type":"structure", + "required":["workspace"], + "members":{ + "workspace":{ + "shape":"WorkspaceDescription", + "documentation":"A structure containing information about the workspace.
" + } + } + }, + "Endpoint":{ + "type":"string", + "max":2048, + "min":1 + }, + "GrafanaVersion":{ + "type":"string", + "max":255, + "min":1 + }, + "IamRoleArn":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "IdpMetadata":{ + "type":"structure", + "members":{ + "url":{ + "shape":"IdpMetadataUrl", + "documentation":"The URL of the location containing the metadata.
" + }, + "xml":{ + "shape":"String", + "documentation":"The actual full metadata file, in XML format.
" + } + }, + "documentation":"A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the url parameter, or by specifying the full metadata in XML format in the xml parameter.
A description of the error.
" + }, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"How long to wait before you retry this operation.
", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"Unexpected error while processing the request. Retry the request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "LicenseType":{ + "type":"string", + "enum":[ + "ENTERPRISE", + "ENTERPRISE_FREE_TRIAL" + ] + }, + "ListPermissionsRequest":{ + "type":"structure", + "required":["workspaceId"], + "members":{ + "groupId":{ + "shape":"SsoId", + "documentation":"(Optional) Limits the results to only the group that matches this ID.
", + "location":"querystring", + "locationName":"groupId" + }, + "maxResults":{ + "shape":"ListPermissionsRequestMaxResultsInteger", + "documentation":"The maximum number of results to include in the response.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.
(Optional) Limits the results to only the user that matches this ID.
", + "location":"querystring", + "locationName":"userId" + }, + "userType":{ + "shape":"UserType", + "documentation":"(Optional) If you specify SSO_USER, then only the permissions of Amazon Web Services SSO users are returned. If you specify SSO_GROUP, only the permissions of Amazon Web Services SSO groups are returned.
The ID of the workspace to list permissions for. This parameter is required.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "ListPermissionsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListPermissionsResponse":{ + "type":"structure", + "required":["permissions"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token to use in a subsequent ListPermissions operation to return the next set of results.
The permissions returned by the operation.
" + } + } + }, + "ListWorkspacesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListWorkspacesRequestMaxResultsInteger", + "documentation":"The maximum number of workspaces to include in the results.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)
The token to use when requesting the next set of workspaces.
" + }, + "workspaces":{ + "shape":"WorkspaceList", + "documentation":"An array of structures that contain some information about the workspaces in the account.
" + } + } + }, + "LoginValidityDuration":{"type":"integer"}, + "NotificationDestinationType":{ + "type":"string", + "enum":["SNS"] + }, + "NotificationDestinationsList":{ + "type":"list", + "member":{"shape":"NotificationDestinationType"} + }, + "OrganizationRoleName":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "OrganizationalUnit":{"type":"string"}, + "OrganizationalUnitList":{ + "type":"list", + "member":{"shape":"OrganizationalUnit"}, + "sensitive":true + }, + "PaginationToken":{"type":"string"}, + "PermissionEntry":{ + "type":"structure", + "required":[ + "role", + "user" + ], + "members":{ + "role":{ + "shape":"Role", + "documentation":"Specifies whether the user or group has the Admin or Editor role.
A structure with the ID of the user or group with this role.
" + } + }, + "documentation":"A structure containing the identity of one user or group and the Admin or Editor role that they have.
The value of a parameter in the request caused an error.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the resource that is associated with the error.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of the resource that is associated with the error.
" + } + }, + "documentation":"The request references a resource that does not exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "Role":{ + "type":"string", + "enum":[ + "ADMIN", + "EDITOR" + ] + }, + "RoleValue":{ + "type":"string", + "max":256, + "min":1 + }, + "RoleValueList":{ + "type":"list", + "member":{"shape":"RoleValue"} + }, + "RoleValues":{ + "type":"structure", + "members":{ + "admin":{ + "shape":"RoleValueList", + "documentation":"A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace.
A structure containing details about how this workspace works with SAML.
" + }, + "status":{ + "shape":"SamlConfigurationStatus", + "documentation":"Specifies whether the workspace's SAML configuration is complete.
" + } + }, + "documentation":"A structure containing information about how this workspace works with SAML.
" + }, + "SamlConfiguration":{ + "type":"structure", + "required":["idpMetadata"], + "members":{ + "allowedOrganizations":{ + "shape":"AllowedOrganizations", + "documentation":"Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.
" + }, + "assertionAttributes":{ + "shape":"AssertionAttributes", + "documentation":"A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
" + }, + "idpMetadata":{ + "shape":"IdpMetadata", + "documentation":"A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
" + }, + "loginValidityDuration":{ + "shape":"LoginValidityDuration", + "documentation":"How long a sign-on session by a SAML user is valid, before the user has to sign on again.
" + }, + "roleValues":{ + "shape":"RoleValues", + "documentation":"A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
A structure containing information about how this workspace works with SAML.
" + }, + "SamlConfigurationStatus":{ + "type":"string", + "enum":[ + "CONFIGURED", + "NOT_CONFIGURED" + ] + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "message", + "quotaCode", + "resourceId", + "resourceType", + "serviceCode" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"A description of the error.
" + }, + "quotaCode":{ + "shape":"String", + "documentation":"The ID of the service quota that was exceeded.
" + }, + "resourceId":{ + "shape":"String", + "documentation":"The ID of the resource that is associated with the error.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The type of the resource that is associated with the error.
" + }, + "serviceCode":{ + "shape":"String", + "documentation":"The value of a parameter in the request caused an error.
" + } + }, + "documentation":"The request would cause a service quota to be exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SsoId":{ + "type":"string", + "max":47, + "min":1 + }, + "StackSetName":{"type":"string"}, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"A description of the error.
" + }, + "quotaCode":{ + "shape":"String", + "documentation":"The ID of the service quota that was exceeded.
" + }, + "retryAfterSeconds":{ + "shape":"Integer", + "documentation":"The value of a parameter in the request caused an error.
", + "location":"header", + "locationName":"Retry-After" + }, + "serviceCode":{ + "shape":"String", + "documentation":"The ID of the service that is associated with the error.
" + } + }, + "documentation":"The request was denied because of request throttling. Retry the request.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "Timestamp":{"type":"timestamp"}, + "UpdateAction":{ + "type":"string", + "enum":[ + "ADD", + "REVOKE" + ] + }, + "UpdateError":{ + "type":"structure", + "required":[ + "causedBy", + "code", + "message" + ], + "members":{ + "causedBy":{ + "shape":"UpdateInstruction", + "documentation":"Specifies which permission update caused the error.
" + }, + "code":{ + "shape":"UpdateErrorCodeInteger", + "documentation":"The error code.
" + }, + "message":{ + "shape":"String", + "documentation":"The message for this error.
" + } + }, + "documentation":"A structure containing information about one error encountered while performing an UpdatePermissions operation.
" + }, + "UpdateErrorCodeInteger":{ + "type":"integer", + "box":true, + "max":999, + "min":100 + }, + "UpdateErrorList":{ + "type":"list", + "member":{"shape":"UpdateError"} + }, + "UpdateInstruction":{ + "type":"structure", + "required":[ + "action", + "role", + "users" + ], + "members":{ + "action":{ + "shape":"UpdateAction", + "documentation":"Specifies whether this update is to add or revoke role permissions.
" + }, + "role":{ + "shape":"Role", + "documentation":"The role to add or revoke for the user or the group specified in users.
A structure that specifies the user or group to add or revoke the role for.
" + } + }, + "documentation":"Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.
" + }, + "UpdateInstructionBatch":{ + "type":"list", + "member":{"shape":"UpdateInstruction"}, + "max":20, + "min":0 + }, + "UpdatePermissionsRequest":{ + "type":"structure", + "required":[ + "updateInstructionBatch", + "workspaceId" + ], + "members":{ + "updateInstructionBatch":{ + "shape":"UpdateInstructionBatch", + "documentation":"An array of structures that contain the permission updates to make.
" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to update.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "UpdatePermissionsResponse":{ + "type":"structure", + "required":["errors"], + "members":{ + "errors":{ + "shape":"UpdateErrorList", + "documentation":"An array of structures that contain the errors from the operation, if any.
" + } + } + }, + "UpdateWorkspaceAuthenticationRequest":{ + "type":"structure", + "required":[ + "authenticationProviders", + "workspaceId" + ], + "members":{ + "authenticationProviders":{ + "shape":"AuthenticationProviders", + "documentation":"Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single Sign On, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
" + }, + "samlConfiguration":{ + "shape":"SamlConfiguration", + "documentation":"If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.
The ID of the workspace to update the authentication for.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "UpdateWorkspaceAuthenticationResponse":{ + "type":"structure", + "required":["authentication"], + "members":{ + "authentication":{ + "shape":"AuthenticationDescription", + "documentation":"A structure that describes the user authentication for this workspace after the update is made.
" + } + } + }, + "UpdateWorkspaceRequest":{ + "type":"structure", + "required":["workspaceId"], + "members":{ + "accountAccessType":{ + "shape":"AccountAccessType", + "documentation":"Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.
The name of an IAM role that already exists to use to access resources through Organizations.
" + }, + "permissionType":{ + "shape":"PermissionType", + "documentation":"If you specify Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
If you specify CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.
For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
" + }, + "stackSetName":{ + "shape":"StackSetName", + "documentation":"The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
" + }, + "workspaceDataSources":{ + "shape":"DataSourceTypesList", + "documentation":"Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.
If you don't specify a data source here, you can still add it as a data source later in the workspace console. However, you will then have to manually configure permissions for it.
" + }, + "workspaceDescription":{ + "shape":"Description", + "documentation":"A description for the workspace. This is used only to help you identify this workspace.
" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to update.
", + "location":"uri", + "locationName":"workspaceId" + }, + "workspaceName":{ + "shape":"WorkspaceName", + "documentation":"A new name for the workspace to update.
" + }, + "workspaceNotificationDestinations":{ + "shape":"NotificationDestinationsList", + "documentation":"Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
" + }, + "workspaceOrganizationalUnits":{ + "shape":"OrganizationalUnitList", + "documentation":"Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
" + }, + "workspaceRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. If you omit this field and you specify some Amazon Web Services resources in workspaceDataSources or workspaceNotificationDestinations, a new IAM role with the necessary permissions is automatically created.
A structure containing data about the workspace that was created.
" + } + } + }, + "User":{ + "type":"structure", + "required":[ + "id", + "type" + ], + "members":{ + "id":{ + "shape":"SsoId", + "documentation":"The ID of the user or group.
" + }, + "type":{ + "shape":"UserType", + "documentation":"Specifies whether this is a single user or a group.
" + } + }, + "documentation":"A structure that specifies one user or group in the workspace.
" + }, + "UserList":{ + "type":"list", + "member":{"shape":"User"} + }, + "UserType":{ + "type":"string", + "enum":[ + "SSO_USER", + "SSO_GROUP" + ] + }, + "ValidationException":{ + "type":"structure", + "required":[ + "message", + "reason" + ], + "members":{ + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"A list of fields that might be associated with the error.
" + }, + "message":{ + "shape":"String", + "documentation":"A description of the error.
" + }, + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason that the operation failed.
" + } + }, + "documentation":"The value of a parameter in the request caused an error.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "message", + "name" + ], + "members":{ + "message":{ + "shape":"String", + "documentation":"A message describing why this field couldn't be validated.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the field that caused the validation error.
" + } + }, + "documentation":"A structure that contains information about a request parameter that caused an error.
" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UNKNOWN_OPERATION", + "CANNOT_PARSE", + "FIELD_VALIDATION_FAILED", + "OTHER" + ] + }, + "WorkspaceDescription":{ + "type":"structure", + "required":[ + "authentication", + "created", + "dataSources", + "endpoint", + "grafanaVersion", + "id", + "modified", + "status" + ], + "members":{ + "accountAccessType":{ + "shape":"AccountAccessType", + "documentation":"Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If this is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which organizational units the workspace can access.
A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication.
" + }, + "created":{ + "shape":"Timestamp", + "documentation":"The date that the workspace was created.
" + }, + "dataSources":{ + "shape":"DataSourceTypesList", + "documentation":"Specifies the Amazon Web Services data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources.
" + }, + "description":{ + "shape":"Description", + "documentation":"The user-defined description of the workspace.
" + }, + "endpoint":{ + "shape":"Endpoint", + "documentation":"The URL that users can use to access the Grafana console in the workspace.
" + }, + "freeTrialConsumed":{ + "shape":"Boolean", + "documentation":"Specifies whether this workspace has already fully used its free trial for Grafana Enterprise.
" + }, + "freeTrialExpiration":{ + "shape":"Timestamp", + "documentation":"If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends.
" + }, + "grafanaVersion":{ + "shape":"GrafanaVersion", + "documentation":"The version of Grafana supported in this workspace.
" + }, + "id":{ + "shape":"WorkspaceId", + "documentation":"The unique ID of this workspace.
" + }, + "licenseExpiration":{ + "shape":"Timestamp", + "documentation":"If this workspace has a full Grafana Enterprise license, this specifies when the license ends and will need to be renewed.
" + }, + "licenseType":{ + "shape":"LicenseType", + "documentation":"Specifies whether this workspace has a full Grafana Enterprise license or a free trial license.
" + }, + "modified":{ + "shape":"Timestamp", + "documentation":"The most recent date that the workspace was modified.
" + }, + "name":{ + "shape":"WorkspaceName", + "documentation":"The name of the workspace.
" + }, + "notificationDestinations":{ + "shape":"NotificationDestinationsList", + "documentation":"The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels.
" + }, + "organizationRoleName":{ + "shape":"OrganizationRoleName", + "documentation":"The name of the IAM role that is used to access resources through Organizations.
" + }, + "organizationalUnits":{ + "shape":"OrganizationalUnitList", + "documentation":"Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
" + }, + "permissionType":{ + "shape":"PermissionType", + "documentation":"If this is Service Managed, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
If this is CUSTOMER_MANAGED, you manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose CUSTOMER_MANAGED.
For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
" + }, + "stackSetName":{ + "shape":"StackSetName", + "documentation":"The name of the CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
" + }, + "status":{ + "shape":"WorkspaceStatus", + "documentation":"The current status of the workspace.
" + }, + "workspaceRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.
" + } + }, + "documentation":"A structure containing information about an Amazon Managed Grafana workspace in your account.
" + }, + "WorkspaceId":{ + "type":"string", + "pattern":"^g-[0-9a-f]{10}$" + }, + "WorkspaceList":{ + "type":"list", + "member":{"shape":"WorkspaceSummary"} + }, + "WorkspaceName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9-._~]{1,255}$", + "sensitive":true + }, + "WorkspaceStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "CREATING", + "DELETING", + "FAILED", + "UPDATING", + "UPGRADING", + "DELETION_FAILED", + "CREATION_FAILED", + "UPDATE_FAILED", + "UPGRADE_FAILED", + "LICENSE_REMOVAL_FAILED" + ] + }, + "WorkspaceSummary":{ + "type":"structure", + "required":[ + "authentication", + "created", + "endpoint", + "grafanaVersion", + "id", + "modified", + "status" + ], + "members":{ + "authentication":{ + "shape":"AuthenticationSummary", + "documentation":"A structure containing information about the authentication methods used in the workspace.
" + }, + "created":{ + "shape":"Timestamp", + "documentation":"The date that the workspace was created.
" + }, + "description":{ + "shape":"Description", + "documentation":"The customer-entered description of the workspace.
" + }, + "endpoint":{ + "shape":"Endpoint", + "documentation":"The URL endpoint to use to access the Grafana console in the workspace.
" + }, + "grafanaVersion":{ + "shape":"GrafanaVersion", + "documentation":"The Grafana version that the workspace is running.
" + }, + "id":{ + "shape":"WorkspaceId", + "documentation":"The unique ID of the workspace.
" + }, + "modified":{ + "shape":"Timestamp", + "documentation":"The most recent date that the workspace was modified.
" + }, + "name":{ + "shape":"WorkspaceName", + "documentation":"The name of the workspace.
" + }, + "notificationDestinations":{ + "shape":"NotificationDestinationsList", + "documentation":"The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
" + }, + "status":{ + "shape":"WorkspaceStatus", + "documentation":"The current status of the workspace.
" + } + }, + "documentation":"A structure that contains some information about one workspace in the account.
" + } + }, + "documentation":"Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.
With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.
" +} diff --git a/botocore/data/kendra/2019-02-03/service-2.json b/botocore/data/kendra/2019-02-03/service-2.json index 544bf5daad..0a7f6010f7 100644 --- a/botocore/data/kendra/2019-02-03/service-2.json +++ b/botocore/data/kendra/2019-02-03/service-2.json @@ -1574,6 +1574,10 @@ "shape":"ClientTokenName", "documentation":"A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource operation with the same client token will create only one data source.
The code for a language. This allows you to support a language for all documents when creating the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
" } } }, @@ -1628,6 +1632,10 @@ "shape":"ClientTokenName", "documentation":"A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest operation with the same client token will create only one FAQ.
The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
" } } }, @@ -1935,6 +1943,10 @@ "Status":{ "shape":"DataSourceStatus", "documentation":"The status of the data source. When the status is ACTIVE the data source is ready to use.
The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
" } }, "documentation":"Summary information for a Amazon Kendra data source. Returned in a call to the DescribeDataSource operation.
When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
" } } }, @@ -2396,6 +2412,10 @@ "FileFormat":{ "shape":"FaqFileFormat", "documentation":"The file format used by the input files for the FAQ.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
" } } }, @@ -3114,6 +3134,10 @@ "FileFormat":{ "shape":"FaqFileFormat", "documentation":"The file type used to create the FAQ.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
" } }, "documentation":"Provides information about a frequently asked questions and answer contained in an index.
" @@ -3531,6 +3555,13 @@ "min":1, "sensitive":true }, + "LanguageCode":{ + "type":"string", + "documentation":"The code for a language. The default language is English. For more information on supported languages, including their codes, see Adding documents in languages other than English.
", + "max":10, + "min":2, + "pattern":"[a-zA-Z-]*" + }, "ListDataSourceSyncJobsRequest":{ "type":"structure", "required":[ @@ -4760,7 +4791,8 @@ "VERY_HIGH", "HIGH", "MEDIUM", - "LOW" + "LOW", + "NOT_AVAILABLE" ] }, "Search":{ @@ -5517,6 +5549,10 @@ "RoleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.
" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"The code for a language. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
" } } }, diff --git a/botocore/data/schemas/2019-12-02/service-2.json b/botocore/data/schemas/2019-12-02/service-2.json index f4b473847b..f1731da63c 100644 --- a/botocore/data/schemas/2019-12-02/service-2.json +++ b/botocore/data/schemas/2019-12-02/service-2.json @@ -2540,65 +2540,6 @@ } } }, - "LockServiceLinkedRoleInput": { - "type": "structure", - "members": { - "RoleArn": { - "shape": "__stringMin1Max1600" - }, - "Timeout": { - "shape": "__integerMin1Max29000" - } - }, - "required": [ - "Timeout", - "RoleArn" - ] - }, - "LockServiceLinkedRoleOutput": { - "type": "structure", - "members": { - "CanBeDeleted": { - "shape": "__boolean" - }, - "ReasonOfFailure": { - "shape": "__stringMin1Max1600" - }, - "RelatedResources": { - "shape": "__listOfDiscovererSummary" - } - } - }, - "LockServiceLinkedRoleRequest": { - "type": "structure", - "members": { - "RoleArn": { - "shape": "__stringMin1Max1600" - }, - "Timeout": { - "shape": "__integerMin1Max29000" - } - }, - "documentation": "", - "required": [ - "Timeout", - "RoleArn" - ] - }, - "LockServiceLinkedRoleResponse": { - "type": "structure", - "members": { - "CanBeDeleted": { - "shape": "__boolean" - }, - "ReasonOfFailure": { - "shape": "__stringMin1Max1600" - }, - "RelatedResources": { - "shape": "__listOfDiscovererSummary" - } - } - }, "NotFoundException": { "type": "structure", "members": { @@ -3156,32 +3097,6 @@ "httpStatusCode": 401 } }, - "UnlockServiceLinkedRoleInput": { - "type": "structure", - "members": { - "RoleArn": { - "shape": "__stringMin1Max1600" - } - }, - "required": [ - "RoleArn" - ] - }, - "UnlockServiceLinkedRoleRequest": { - "type": "structure", - "members": { - "RoleArn": { - "shape": "__stringMin1Max1600" - } - }, - "required": [ - "RoleArn" - ] - }, - "UnlockServiceLinkedRoleResponse": { - "type": "structure", - "members": {} - }, "UntagResourceRequest": { "type": "structure", "members": { diff --git a/docs/source/conf.py b/docs/source/conf.py index 81d42b3b63..f9d3257669 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ # The short X.Y version. version = '1.21.' # The full version, including alpha/beta/rc tags. -release = '1.21.56' +release = '1.21.57' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.