From d53f481e319e04461496026a8381726faff4c127 Mon Sep 17 00:00:00 2001 From: Christophe Coevoet Date: Mon, 26 Jun 2023 10:27:15 +0200 Subject: [PATCH] Generate the property type for generated objects --- psalm.baseline.xml | 15 ++++ .../CodeGenerator/PopulatorGenerator.php | 6 +- .../src/Generator/ObjectGenerator.php | 3 + .../src/Sts/Result/AssumeRoleResponse.php | 8 ++ .../AssumeRoleWithWebIdentityResponse.php | 14 ++++ .../Sts/Result/GetCallerIdentityResponse.php | 6 ++ .../src/Sts/ValueObject/AssumedRoleUser.php | 4 + src/Core/src/Sts/ValueObject/Credentials.php | 8 ++ .../Sts/ValueObject/PolicyDescriptorType.php | 2 + src/Core/src/Sts/ValueObject/Tag.php | 4 + .../src/Exception/BadRequestException.php | 6 ++ .../src/Result/CreateResolverResponse.php | 2 + .../GetSchemaCreationStatusResponse.php | 4 + .../src/Result/ListApiKeysResponse.php | 4 + .../src/Result/ListResolversResponse.php | 4 + .../Result/StartSchemaCreationResponse.php | 2 + .../src/Result/UpdateApiKeyResponse.php | 2 + .../src/Result/UpdateDataSourceResponse.php | 2 + .../src/Result/UpdateResolverResponse.php | 2 + .../AppSync/src/ValueObject/ApiKey.php | 8 ++ .../src/ValueObject/AppSyncRuntime.php | 4 + .../src/ValueObject/AuthorizationConfig.php | 4 + .../AppSync/src/ValueObject/AwsIamConfig.php | 4 + .../src/ValueObject/BadRequestDetail.php | 2 + .../AppSync/src/ValueObject/CachingConfig.php | 4 + .../AppSync/src/ValueObject/CodeError.php | 6 ++ .../src/ValueObject/CodeErrorLocation.php | 6 ++ .../AppSync/src/ValueObject/DataSource.php | 24 ++++++ .../src/ValueObject/DeltaSyncConfig.php | 6 ++ .../ValueObject/DynamodbDataSourceConfig.php | 10 +++ .../ElasticsearchDataSourceConfig.php | 4 + .../EventBridgeDataSourceConfig.php | 2 + .../src/ValueObject/HttpDataSourceConfig.php | 4 + .../LambdaConflictHandlerConfig.php | 2 + .../ValueObject/LambdaDataSourceConfig.php | 2 + .../OpenSearchServiceDataSourceConfig.php | 4 + .../src/ValueObject/PipelineConfig.php | 2 + .../src/ValueObject/RdsHttpEndpointConfig.php | 10 +++ .../RelationalDatabaseDataSourceConfig.php | 4 + .../AppSync/src/ValueObject/Resolver.php | 27 ++++++ .../AppSync/src/ValueObject/SyncConfig.php | 6 ++ .../src/Exception/InvalidRequestException.php | 3 + .../Exception/ResourceNotFoundException.php | 2 + .../Exception/TooManyRequestsException.php | 3 + .../GetCalculationExecutionResponse.php | 14 ++++ .../GetCalculationExecutionStatusResponse.php | 4 + .../src/Result/GetDataCatalogOutput.php | 2 + .../Athena/src/Result/GetDatabaseOutput.php | 2 + .../Athena/src/Result/GetNamedQueryOutput.php | 2 + .../src/Result/GetQueryExecutionOutput.php | 2 + .../src/Result/GetQueryResultsOutput.php | 6 ++ .../Athena/src/Result/GetSessionResponse.php | 18 ++++ .../src/Result/GetSessionStatusResponse.php | 4 + .../src/Result/GetTableMetadataOutput.php | 2 + .../Athena/src/Result/GetWorkGroupOutput.php | 2 + .../Athena/src/Result/ListDatabasesOutput.php | 4 + .../src/Result/ListNamedQueriesOutput.php | 4 + .../src/Result/ListQueryExecutionsOutput.php | 4 + .../src/Result/ListTableMetadataOutput.php | 4 + .../StartCalculationExecutionResponse.php | 4 + .../src/Result/StartQueryExecutionOutput.php | 2 + .../src/Result/StartSessionResponse.php | 4 + .../StopCalculationExecutionResponse.php | 2 + .../src/Result/TerminateSessionResponse.php | 2 + .../src/ValueObject/AclConfiguration.php | 2 + .../Athena/src/ValueObject/AthenaError.php | 8 ++ .../ValueObject/CalculationConfiguration.php | 2 + .../src/ValueObject/CalculationResult.php | 8 ++ .../src/ValueObject/CalculationStatistics.php | 4 + .../src/ValueObject/CalculationStatus.php | 8 ++ src/Service/Athena/src/ValueObject/Column.php | 6 ++ .../Athena/src/ValueObject/ColumnInfo.php | 20 +++++ ...CustomerContentEncryptionConfiguration.php | 2 + .../Athena/src/ValueObject/DataCatalog.php | 8 ++ .../Athena/src/ValueObject/Database.php | 6 ++ src/Service/Athena/src/ValueObject/Datum.php | 2 + .../ValueObject/EncryptionConfiguration.php | 4 + .../src/ValueObject/EngineConfiguration.php | 10 +++ .../Athena/src/ValueObject/EngineVersion.php | 4 + .../Athena/src/ValueObject/NamedQuery.php | 12 +++ .../Athena/src/ValueObject/QueryExecution.php | 24 ++++++ .../src/ValueObject/QueryExecutionContext.php | 4 + .../ValueObject/QueryExecutionStatistics.php | 16 ++++ .../src/ValueObject/QueryExecutionStatus.php | 10 +++ .../src/ValueObject/ResultConfiguration.php | 8 ++ .../ResultReuseByAgeConfiguration.php | 4 + .../ValueObject/ResultReuseConfiguration.php | 2 + .../ValueObject/ResultReuseInformation.php | 2 + .../Athena/src/ValueObject/ResultSet.php | 4 + .../src/ValueObject/ResultSetMetadata.php | 2 + src/Service/Athena/src/ValueObject/Row.php | 2 + .../src/ValueObject/SessionConfiguration.php | 9 ++ .../src/ValueObject/SessionStatistics.php | 2 + .../Athena/src/ValueObject/SessionStatus.php | 12 +++ .../Athena/src/ValueObject/TableMetadata.php | 14 ++++ .../Athena/src/ValueObject/WorkGroup.php | 10 +++ .../ValueObject/WorkGroupConfiguration.php | 20 +++++ ...escribeStackDriftDetectionStatusOutput.php | 14 ++++ .../src/Result/DescribeStackEventsOutput.php | 4 + .../src/Result/DescribeStacksOutput.php | 4 + .../CloudFormation/src/ValueObject/Output.php | 8 ++ .../src/ValueObject/Parameter.php | 8 ++ .../src/ValueObject/RollbackConfiguration.php | 4 + .../src/ValueObject/RollbackTrigger.php | 4 + .../CloudFormation/src/ValueObject/Stack.php | 44 ++++++++++ .../src/ValueObject/StackDriftInformation.php | 4 + .../src/ValueObject/StackEvent.php | 32 +++++++ .../CloudFormation/src/ValueObject/Tag.php | 4 + .../src/Result/CreateInvalidationResult.php | 4 + .../src/ValueObject/Invalidation.php | 8 ++ .../src/ValueObject/InvalidationBatch.php | 4 + .../CloudFront/src/ValueObject/Paths.php | 4 + .../src/Result/GetMetricDataOutput.php | 6 ++ .../src/Result/GetMetricStatisticsOutput.php | 4 + .../src/Result/ListMetricsOutput.php | 6 ++ .../CloudWatch/src/ValueObject/Datapoint.php | 16 ++++ .../CloudWatch/src/ValueObject/Dimension.php | 4 + .../src/ValueObject/DimensionFilter.php | 4 + .../src/ValueObject/LabelOptions.php | 2 + .../src/ValueObject/MessageData.php | 4 + .../CloudWatch/src/ValueObject/Metric.php | 6 ++ .../src/ValueObject/MetricDataQuery.php | 14 ++++ .../src/ValueObject/MetricDataResult.php | 12 +++ .../src/ValueObject/MetricDatum.php | 18 ++++ .../CloudWatch/src/ValueObject/MetricStat.php | 8 ++ .../src/ValueObject/StatisticSet.php | 8 ++ .../DataAlreadyAcceptedException.php | 3 + .../InvalidSequenceTokenException.php | 3 + .../src/Result/DescribeLogStreamsResponse.php | 5 ++ .../src/Result/FilterLogEventsResponse.php | 6 ++ .../src/Result/PutLogEventsResponse.php | 4 + .../src/ValueObject/FilteredLogEvent.php | 10 +++ .../src/ValueObject/InputLogEvent.php | 4 + .../src/ValueObject/LogStream.php | 16 ++++ .../src/ValueObject/RejectedLogEventsInfo.php | 6 ++ .../src/ValueObject/SearchedLogStream.php | 4 + .../src/Result/BatchGetBuildsOutput.php | 4 + .../CodeBuild/src/Result/StartBuildOutput.php | 2 + .../CodeBuild/src/Result/StopBuildOutput.php | 2 + .../CodeBuild/src/ValueObject/Build.php | 64 ++++++++++++++ .../src/ValueObject/BuildArtifacts.php | 15 ++++ .../CodeBuild/src/ValueObject/BuildPhase.php | 12 +++ .../src/ValueObject/BuildStatusConfig.php | 4 + .../src/ValueObject/CloudWatchLogsConfig.php | 6 ++ .../src/ValueObject/DebugSession.php | 4 + .../src/ValueObject/EnvironmentVariable.php | 6 ++ .../ExportedEnvironmentVariable.php | 4 + .../src/ValueObject/GitSubmodulesConfig.php | 2 + .../CodeBuild/src/ValueObject/LogsConfig.php | 4 + .../src/ValueObject/LogsLocation.php | 16 ++++ .../src/ValueObject/NetworkInterface.php | 4 + .../src/ValueObject/PhaseContext.php | 4 + .../src/ValueObject/ProjectArtifacts.php | 21 +++++ .../src/ValueObject/ProjectCache.php | 6 ++ .../src/ValueObject/ProjectEnvironment.php | 16 ++++ .../ValueObject/ProjectFileSystemLocation.php | 10 +++ .../src/ValueObject/ProjectSource.php | 20 +++++ .../src/ValueObject/ProjectSourceVersion.php | 4 + .../src/ValueObject/RegistryCredential.php | 4 + .../src/ValueObject/S3LogsConfig.php | 9 ++ .../CodeBuild/src/ValueObject/SourceAuth.php | 4 + .../CodeBuild/src/ValueObject/VpcConfig.php | 6 ++ .../src/Result/CreateRepositoryOutput.php | 2 + .../src/Result/DeleteRepositoryOutput.php | 2 + .../CodeCommit/src/Result/GetBlobOutput.php | 2 + .../CodeCommit/src/Result/GetBranchOutput.php | 2 + .../CodeCommit/src/Result/GetCommitOutput.php | 2 + .../src/Result/GetDifferencesOutput.php | 4 + .../src/Result/ListRepositoriesOutput.php | 4 + .../Result/PutRepositoryTriggersOutput.php | 2 + .../src/ValueObject/BlobMetadata.php | 6 ++ .../CodeCommit/src/ValueObject/BranchInfo.php | 4 + .../CodeCommit/src/ValueObject/Commit.php | 14 ++++ .../CodeCommit/src/ValueObject/Difference.php | 6 ++ .../src/ValueObject/RepositoryMetadata.php | 20 +++++ .../src/ValueObject/RepositoryNameIdPair.php | 4 + .../src/ValueObject/RepositoryTrigger.php | 10 +++ .../CodeCommit/src/ValueObject/UserInfo.php | 6 ++ .../src/Result/CreateDeploymentOutput.php | 2 + .../src/Result/GetDeploymentOutput.php | 2 + ...ifecycleEventHookExecutionStatusOutput.php | 2 + .../CodeDeploy/src/ValueObject/Alarm.php | 2 + .../src/ValueObject/AlarmConfiguration.php | 6 ++ .../src/ValueObject/AppSpecContent.php | 4 + .../ValueObject/AutoRollbackConfiguration.php | 4 + .../BlueGreenDeploymentConfiguration.php | 6 ++ .../BlueInstanceTerminationOption.php | 4 + .../src/ValueObject/DeploymentInfo.php | 62 ++++++++++++++ .../src/ValueObject/DeploymentOverview.php | 12 +++ .../src/ValueObject/DeploymentReadyOption.php | 4 + .../src/ValueObject/DeploymentStyle.php | 4 + .../src/ValueObject/EC2TagFilter.php | 6 ++ .../CodeDeploy/src/ValueObject/EC2TagSet.php | 2 + .../CodeDeploy/src/ValueObject/ELBInfo.php | 2 + .../src/ValueObject/ErrorInformation.php | 4 + .../src/ValueObject/GitHubLocation.php | 4 + .../GreenFleetProvisioningOption.php | 2 + .../src/ValueObject/LoadBalancerInfo.php | 6 ++ .../CodeDeploy/src/ValueObject/RawString.php | 4 + .../src/ValueObject/RelatedDeployments.php | 4 + .../src/ValueObject/RevisionLocation.php | 10 +++ .../src/ValueObject/RollbackInfo.php | 6 ++ .../CodeDeploy/src/ValueObject/S3Location.php | 10 +++ .../src/ValueObject/TargetGroupInfo.php | 2 + .../src/ValueObject/TargetGroupPairInfo.php | 6 ++ .../src/ValueObject/TargetInstances.php | 6 ++ .../src/ValueObject/TrafficRoute.php | 2 + .../src/Result/AdminCreateUserResponse.php | 2 + .../src/Result/AdminGetUserResponse.php | 18 ++++ .../src/Result/AdminInitiateAuthResponse.php | 8 ++ .../Result/AssociateSoftwareTokenResponse.php | 4 + .../src/Result/CreateGroupResponse.php | 2 + .../src/Result/ForgotPasswordResponse.php | 2 + .../src/Result/GetUserResponse.php | 10 +++ .../src/Result/InitiateAuthResponse.php | 8 ++ .../src/Result/ListGroupsResponse.php | 4 + .../src/Result/ListUsersResponse.php | 4 + .../Result/ResendConfirmationCodeResponse.php | 2 + .../Result/RespondToAuthChallengeResponse.php | 8 ++ .../src/Result/SignUpResponse.php | 6 ++ .../Result/VerifySoftwareTokenResponse.php | 4 + .../src/ValueObject/AnalyticsMetadataType.php | 2 + .../src/ValueObject/AttributeType.php | 4 + .../ValueObject/AuthenticationResultType.php | 12 +++ .../ValueObject/CodeDeliveryDetailsType.php | 6 ++ .../src/ValueObject/ContextDataType.php | 10 +++ .../src/ValueObject/GroupType.php | 14 ++++ .../src/ValueObject/HttpHeader.php | 4 + .../src/ValueObject/MFAOptionType.php | 4 + .../src/ValueObject/NewDeviceMetadataType.php | 4 + .../src/ValueObject/SMSMfaSettingsType.php | 4 + .../SoftwareTokenMfaSettingsType.php | 4 + .../src/ValueObject/UserContextDataType.php | 4 + .../src/ValueObject/UserType.php | 14 ++++ .../src/Exception/InvalidRequestException.php | 6 ++ .../Result/DetectDominantLanguageResponse.php | 2 + .../src/ValueObject/DominantLanguage.php | 4 + .../src/ValueObject/InvalidRequestDetail.php | 2 + .../TransactionCanceledException.php | 2 + .../src/Result/BatchGetItemOutput.php | 6 ++ .../src/Result/BatchWriteItemOutput.php | 6 ++ .../DynamoDb/src/Result/CreateTableOutput.php | 2 + .../DynamoDb/src/Result/DeleteItemOutput.php | 6 ++ .../DynamoDb/src/Result/DeleteTableOutput.php | 2 + .../src/Result/DescribeEndpointsResponse.php | 2 + .../src/Result/DescribeTableOutput.php | 2 + .../src/Result/ExecuteStatementOutput.php | 9 ++ .../DynamoDb/src/Result/GetItemOutput.php | 4 + .../DynamoDb/src/Result/ListTablesOutput.php | 4 + .../DynamoDb/src/Result/PutItemOutput.php | 6 ++ .../DynamoDb/src/Result/QueryOutput.php | 10 +++ .../DynamoDb/src/Result/ScanOutput.php | 10 +++ .../src/Result/TransactWriteItemsOutput.php | 4 + .../DynamoDb/src/Result/UpdateItemOutput.php | 6 ++ .../DynamoDb/src/Result/UpdateTableOutput.php | 2 + .../src/Result/UpdateTimeToLiveOutput.php | 2 + .../src/ValueObject/ArchivalSummary.php | 6 ++ .../src/ValueObject/AttributeDefinition.php | 4 + .../src/ValueObject/AttributeValue.php | 20 +++++ .../src/ValueObject/AttributeValueUpdate.php | 4 + .../src/ValueObject/BillingModeSummary.php | 4 + .../src/ValueObject/CancellationReason.php | 6 ++ .../DynamoDb/src/ValueObject/Capacity.php | 6 ++ .../DynamoDb/src/ValueObject/Condition.php | 4 + .../src/ValueObject/ConditionCheck.php | 12 +++ .../src/ValueObject/ConsumedCapacity.php | 14 ++++ .../CreateGlobalSecondaryIndexAction.php | 8 ++ .../CreateReplicationGroupMemberAction.php | 10 +++ .../DynamoDb/src/ValueObject/Delete.php | 12 +++ .../DeleteGlobalSecondaryIndexAction.php | 2 + .../DeleteReplicationGroupMemberAction.php | 2 + .../src/ValueObject/DeleteRequest.php | 2 + .../DynamoDb/src/ValueObject/Endpoint.php | 4 + .../ValueObject/ExpectedAttributeValue.php | 8 ++ .../src/ValueObject/GlobalSecondaryIndex.php | 8 ++ .../GlobalSecondaryIndexDescription.php | 18 ++++ .../GlobalSecondaryIndexUpdate.php | 6 ++ .../src/ValueObject/ItemCollectionMetrics.php | 4 + .../src/ValueObject/KeySchemaElement.php | 4 + .../src/ValueObject/KeysAndAttributes.php | 10 +++ .../src/ValueObject/LocalSecondaryIndex.php | 6 ++ .../LocalSecondaryIndexDescription.php | 12 +++ .../DynamoDb/src/ValueObject/Projection.php | 4 + .../src/ValueObject/ProvisionedThroughput.php | 4 + .../ProvisionedThroughputDescription.php | 10 +++ .../ProvisionedThroughputOverride.php | 2 + src/Service/DynamoDb/src/ValueObject/Put.php | 12 +++ .../DynamoDb/src/ValueObject/PutRequest.php | 2 + .../src/ValueObject/ReplicaDescription.php | 19 +++++ .../ReplicaGlobalSecondaryIndex.php | 4 + ...ReplicaGlobalSecondaryIndexDescription.php | 4 + .../ValueObject/ReplicationGroupUpdate.php | 6 ++ .../src/ValueObject/RestoreSummary.php | 8 ++ .../src/ValueObject/SSEDescription.php | 8 ++ .../src/ValueObject/SSESpecification.php | 6 ++ .../src/ValueObject/StreamSpecification.php | 4 + .../src/ValueObject/TableClassSummary.php | 4 + .../src/ValueObject/TableDescription.php | 46 ++++++++++ src/Service/DynamoDb/src/ValueObject/Tag.php | 4 + .../ValueObject/TimeToLiveSpecification.php | 4 + .../src/ValueObject/TransactWriteItem.php | 8 ++ .../DynamoDb/src/ValueObject/Update.php | 14 ++++ .../UpdateGlobalSecondaryIndexAction.php | 4 + .../UpdateReplicationGroupMemberAction.php | 10 +++ .../DynamoDb/src/ValueObject/WriteRequest.php | 4 + .../Result/GetAuthorizationTokenResponse.php | 2 + .../Ecr/src/ValueObject/AuthorizationData.php | 6 ++ .../src/Result/CacheClusterMessage.php | 4 + .../src/ValueObject/CacheCluster.php | 67 +++++++++++++++ .../ElastiCache/src/ValueObject/CacheNode.php | 16 ++++ .../ValueObject/CacheParameterGroupStatus.php | 6 ++ .../CacheSecurityGroupMembership.php | 4 + .../CloudWatchLogsDestinationDetails.php | 2 + .../src/ValueObject/DestinationDetails.php | 4 + .../ElastiCache/src/ValueObject/Endpoint.php | 4 + .../KinesisFirehoseDestinationDetails.php | 2 + .../ValueObject/LogDeliveryConfiguration.php | 12 +++ .../ValueObject/NotificationConfiguration.php | 4 + .../PendingLogDeliveryConfiguration.php | 8 ++ .../src/ValueObject/PendingModifiedValues.php | 16 ++++ .../ValueObject/SecurityGroupMembership.php | 4 + .../src/Result/PutEventsResponse.php | 4 + .../src/ValueObject/PutEventsRequestEntry.php | 14 ++++ .../src/ValueObject/PutEventsResultEntry.php | 6 ++ .../src/Result/PutRecordBatchOutput.php | 6 ++ .../Firehose/src/Result/PutRecordOutput.php | 4 + .../PutRecordBatchResponseEntry.php | 6 ++ .../Firehose/src/ValueObject/Record.php | 2 + .../src/Result/CreateAccessKeyResponse.php | 2 + ...reateServiceSpecificCredentialResponse.php | 2 + .../Iam/src/Result/CreateUserResponse.php | 2 + .../Iam/src/Result/GetUserResponse.php | 2 + ...ListServiceSpecificCredentialsResponse.php | 2 + .../Iam/src/Result/ListUsersResponse.php | 6 ++ src/Service/Iam/src/ValueObject/AccessKey.php | 10 +++ .../AttachedPermissionsBoundary.php | 4 + .../ValueObject/ServiceSpecificCredential.php | 14 ++++ .../ServiceSpecificCredentialMetadata.php | 12 +++ src/Service/Iam/src/ValueObject/Tag.php | 4 + src/Service/Iam/src/ValueObject/User.php | 16 ++++ .../ResourceAlreadyExistsException.php | 4 + .../src/Result/CreateThingGroupResponse.php | 6 ++ .../Iot/src/Result/CreateThingResponse.php | 6 ++ .../src/Result/CreateThingTypeResponse.php | 6 ++ .../ListThingGroupsForThingResponse.php | 4 + .../src/Result/ListThingGroupsResponse.php | 4 + .../Iot/src/Result/ListThingTypesResponse.php | 4 + .../Result/ListThingsInThingGroupResponse.php | 4 + .../Iot/src/Result/ListThingsResponse.php | 4 + .../Iot/src/ValueObject/AttributePayload.php | 4 + .../Iot/src/ValueObject/GroupNameAndArn.php | 4 + src/Service/Iot/src/ValueObject/Tag.php | 4 + .../Iot/src/ValueObject/ThingAttribute.php | 10 +++ .../src/ValueObject/ThingGroupProperties.php | 4 + .../src/ValueObject/ThingTypeDefinition.php | 8 ++ .../Iot/src/ValueObject/ThingTypeMetadata.php | 6 ++ .../src/ValueObject/ThingTypeProperties.php | 4 + .../src/Result/GetThingShadowResponse.php | 2 + .../src/Result/UpdateThingShadowResponse.php | 2 + .../src/Result/DescribeLimitsOutput.php | 8 ++ .../Result/DescribeStreamConsumerOutput.php | 2 + .../src/Result/DescribeStreamOutput.php | 2 + .../Result/DescribeStreamSummaryOutput.php | 2 + .../src/Result/EnhancedMonitoringOutput.php | 8 ++ .../Kinesis/src/Result/GetRecordsOutput.php | 8 ++ .../src/Result/GetShardIteratorOutput.php | 2 + .../Kinesis/src/Result/ListShardsOutput.php | 4 + .../src/Result/ListStreamConsumersOutput.php | 4 + .../Kinesis/src/Result/ListStreamsOutput.php | 10 +++ .../src/Result/ListTagsForStreamOutput.php | 4 + .../Kinesis/src/Result/PutRecordOutput.php | 6 ++ .../Kinesis/src/Result/PutRecordsOutput.php | 6 ++ .../Result/RegisterStreamConsumerOutput.php | 2 + .../src/Result/UpdateShardCountOutput.php | 8 ++ .../Kinesis/src/ValueObject/ChildShard.php | 7 ++ .../Kinesis/src/ValueObject/Consumer.php | 9 ++ .../src/ValueObject/ConsumerDescription.php | 11 +++ .../src/ValueObject/EnhancedMetrics.php | 2 + .../Kinesis/src/ValueObject/HashKeyRange.php | 4 + .../ValueObject/PutRecordsRequestEntry.php | 6 ++ .../src/ValueObject/PutRecordsResultEntry.php | 8 ++ .../Kinesis/src/ValueObject/Record.php | 10 +++ .../src/ValueObject/SequenceNumberRange.php | 4 + src/Service/Kinesis/src/ValueObject/Shard.php | 10 +++ .../Kinesis/src/ValueObject/ShardFilter.php | 6 ++ .../src/ValueObject/StreamDescription.php | 22 +++++ .../ValueObject/StreamDescriptionSummary.php | 22 +++++ .../src/ValueObject/StreamModeDetails.php | 2 + .../Kinesis/src/ValueObject/StreamSummary.php | 11 +++ src/Service/Kinesis/src/ValueObject/Tag.php | 4 + .../Kms/src/Result/CreateKeyResponse.php | 2 + .../Kms/src/Result/DecryptResponse.php | 8 ++ .../Kms/src/Result/EncryptResponse.php | 6 ++ .../src/Result/GenerateDataKeyResponse.php | 8 ++ .../Kms/src/Result/ListAliasesResponse.php | 6 ++ src/Service/Kms/src/Result/SignResponse.php | 6 ++ .../Kms/src/ValueObject/AliasListEntry.php | 10 +++ .../Kms/src/ValueObject/KeyMetadata.php | 48 +++++++++++ .../ValueObject/MultiRegionConfiguration.php | 6 ++ .../Kms/src/ValueObject/MultiRegionKey.php | 4 + .../Kms/src/ValueObject/RecipientInfo.php | 4 + src/Service/Kms/src/ValueObject/Tag.php | 4 + .../ValueObject/XksKeyConfigurationType.php | 2 + .../CodeStorageExceededException.php | 2 + .../Exception/EC2AccessDeniedException.php | 3 + .../src/Exception/EC2ThrottledException.php | 3 + .../src/Exception/EC2UnexpectedException.php | 6 ++ .../Lambda/src/Exception/EFSIOException.php | 3 + .../EFSMountConnectivityException.php | 3 + .../Exception/EFSMountFailureException.php | 3 + .../Exception/EFSMountTimeoutException.php | 3 + .../Exception/ENILimitReachedException.php | 3 + .../InvalidParameterValueException.php | 2 + .../InvalidRequestContentException.php | 2 + .../src/Exception/InvalidRuntimeException.php | 3 + .../InvalidSecurityGroupIDException.php | 3 + .../Exception/InvalidSubnetIDException.php | 3 + .../src/Exception/InvalidZipFileException.php | 3 + .../Exception/KMSAccessDeniedException.php | 3 + .../src/Exception/KMSDisabledException.php | 3 + .../Exception/KMSInvalidStateException.php | 3 + .../src/Exception/KMSNotFoundException.php | 3 + .../PolicyLengthExceededException.php | 3 + .../Exception/PreconditionFailedException.php | 2 + .../RecursiveInvocationException.php | 2 + .../Exception/RequestTooLargeException.php | 3 + .../Exception/ResourceConflictException.php | 2 + .../Exception/ResourceNotFoundException.php | 3 + .../Exception/ResourceNotReadyException.php | 2 + .../Lambda/src/Exception/ServiceException.php | 3 + .../src/Exception/SnapStartException.php | 3 + .../Exception/SnapStartNotReadyException.php | 3 + .../Exception/SnapStartTimeoutException.php | 3 + .../SubnetIPAddressLimitReachedException.php | 3 + .../Exception/TooManyRequestsException.php | 8 ++ .../UnsupportedMediaTypeException.php | 3 + .../AddLayerVersionPermissionResponse.php | 4 + .../Lambda/src/Result/InvocationResponse.php | 10 +++ .../src/Result/ListFunctionsResponse.php | 4 + .../src/Result/ListLayerVersionsResponse.php | 4 + .../Result/ListVersionsByFunctionResponse.php | 4 + .../Result/PublishLayerVersionResponse.php | 18 ++++ .../src/ValueObject/DeadLetterConfig.php | 2 + .../src/ValueObject/EnvironmentError.php | 4 + .../src/ValueObject/EnvironmentResponse.php | 4 + .../src/ValueObject/EphemeralStorage.php | 2 + .../src/ValueObject/FileSystemConfig.php | 4 + .../src/ValueObject/FunctionConfiguration.php | 70 ++++++++++++++++ .../Lambda/src/ValueObject/ImageConfig.php | 6 ++ .../src/ValueObject/ImageConfigError.php | 4 + .../src/ValueObject/ImageConfigResponse.php | 4 + src/Service/Lambda/src/ValueObject/Layer.php | 8 ++ .../ValueObject/LayerVersionContentInput.php | 8 ++ .../ValueObject/LayerVersionContentOutput.php | 10 +++ .../src/ValueObject/LayerVersionsListItem.php | 14 ++++ .../src/ValueObject/RuntimeVersionConfig.php | 4 + .../src/ValueObject/RuntimeVersionError.php | 4 + .../src/ValueObject/SnapStartResponse.php | 4 + .../src/ValueObject/TracingConfigResponse.php | 2 + .../src/ValueObject/VpcConfigResponse.php | 6 ++ .../src/Result/CreateJobResponse.php | 2 + .../src/Result/DescribeEndpointsResponse.php | 4 + .../src/Result/GetJobResponse.php | 2 + .../src/Result/ListJobsResponse.php | 4 + .../src/ValueObject/AacSettings.php | 18 ++++ .../src/ValueObject/Ac3Settings.php | 20 +++++ .../src/ValueObject/AccelerationSettings.php | 2 + .../AdvancedInputFilterSettings.php | 4 + .../src/ValueObject/AiffSettings.php | 6 ++ .../src/ValueObject/AllowedRenditionSize.php | 6 ++ .../ValueObject/AncillarySourceSettings.php | 6 ++ .../AudioChannelTaggingSettings.php | 2 + .../src/ValueObject/AudioCodecSettings.php | 22 +++++ .../src/ValueObject/AudioDescription.php | 22 +++++ .../AudioNormalizationSettings.php | 14 ++++ .../src/ValueObject/AudioSelector.php | 24 ++++++ .../src/ValueObject/AudioSelectorGroup.php | 2 + .../src/ValueObject/AutomatedAbrRule.php | 10 +++ .../src/ValueObject/AutomatedAbrSettings.php | 8 ++ .../ValueObject/AutomatedEncodingSettings.php | 2 + .../src/ValueObject/Av1QvbrSettings.php | 4 + .../src/ValueObject/Av1Settings.php | 26 ++++++ .../src/ValueObject/AvailBlanking.php | 2 + .../src/ValueObject/AvcIntraSettings.php | 20 +++++ .../src/ValueObject/AvcIntraUhdSettings.php | 2 + .../ValueObject/BandwidthReductionFilter.php | 4 + .../ValueObject/BurninDestinationSettings.php | 42 ++++++++++ .../src/ValueObject/CaptionDescription.php | 10 +++ .../CaptionDestinationSettings.php | 20 +++++ .../src/ValueObject/CaptionSelector.php | 6 ++ .../ValueObject/CaptionSourceFramerate.php | 4 + .../src/ValueObject/CaptionSourceSettings.php | 16 ++++ .../src/ValueObject/ChannelMapping.php | 2 + .../src/ValueObject/ClipLimits.php | 8 ++ .../ValueObject/CmafAdditionalManifest.php | 4 + .../ValueObject/CmafEncryptionSettings.php | 12 +++ .../src/ValueObject/CmafGroupSettings.php | 54 ++++++++++++ .../CmafImageBasedTrickPlaySettings.php | 12 +++ .../src/ValueObject/CmfcSettings.php | 28 +++++++ .../src/ValueObject/ColorCorrector.php | 20 +++++ .../src/ValueObject/ContainerSettings.php | 18 ++++ .../ValueObject/DashAdditionalManifest.php | 4 + .../ValueObject/DashIsoEncryptionSettings.php | 4 + .../src/ValueObject/DashIsoGroupSettings.php | 42 ++++++++++ .../DashIsoImageBasedTrickPlaySettings.php | 12 +++ .../src/ValueObject/Deinterlacer.php | 6 ++ .../src/ValueObject/DestinationSettings.php | 2 + .../src/ValueObject/DolbyVision.php | 8 ++ .../ValueObject/DolbyVisionLevel6Metadata.php | 4 + .../src/ValueObject/DvbNitSettings.php | 6 ++ .../src/ValueObject/DvbSdtSettings.php | 8 ++ .../ValueObject/DvbSubDestinationSettings.php | 54 ++++++++++++ .../src/ValueObject/DvbSubSourceSettings.php | 2 + .../src/ValueObject/DvbTdtSettings.php | 2 + .../src/ValueObject/Eac3AtmosSettings.php | 34 ++++++++ .../src/ValueObject/Eac3Settings.php | 42 ++++++++++ .../EmbeddedDestinationSettings.php | 4 + .../ValueObject/EmbeddedSourceSettings.php | 8 ++ .../MediaConvert/src/ValueObject/Endpoint.php | 2 + ...amManifestConfirmConditionNotification.php | 2 + .../src/ValueObject/EsamSettings.php | 6 ++ .../EsamSignalProcessingNotification.php | 2 + .../src/ValueObject/ExtendedDataServices.php | 4 + .../src/ValueObject/F4vSettings.php | 2 + .../src/ValueObject/FileGroupSettings.php | 4 + .../src/ValueObject/FileSourceSettings.php | 12 +++ .../ValueObject/ForceIncludeRenditionSize.php | 4 + .../src/ValueObject/FrameCaptureSettings.php | 8 ++ .../src/ValueObject/H264QvbrSettings.php | 6 ++ .../src/ValueObject/H264Settings.php | 84 +++++++++++++++++++ .../src/ValueObject/H265QvbrSettings.php | 6 ++ .../src/ValueObject/H265Settings.php | 84 +++++++++++++++++++ .../src/ValueObject/Hdr10Metadata.php | 24 ++++++ .../src/ValueObject/Hdr10Plus.php | 4 + .../src/ValueObject/HlsAdditionalManifest.php | 4 + .../ValueObject/HlsCaptionLanguageMapping.php | 8 ++ .../src/ValueObject/HlsEncryptionSettings.php | 14 ++++ .../src/ValueObject/HlsGroupSettings.php | 64 ++++++++++++++ .../HlsImageBasedTrickPlaySettings.php | 12 +++ .../ValueObject/HlsRenditionGroupSettings.php | 6 ++ .../src/ValueObject/HlsSettings.php | 14 ++++ .../src/ValueObject/HopDestination.php | 6 ++ .../src/ValueObject/Id3Insertion.php | 4 + .../src/ValueObject/ImageInserter.php | 4 + .../ValueObject/ImscDestinationSettings.php | 4 + .../MediaConvert/src/ValueObject/Input.php | 48 +++++++++++ .../src/ValueObject/InputClipping.php | 4 + .../ValueObject/InputDecryptionSettings.php | 8 ++ .../src/ValueObject/InputVideoGenerator.php | 2 + .../src/ValueObject/InsertableImage.php | 22 +++++ .../MediaConvert/src/ValueObject/Job.php | 54 ++++++++++++ .../src/ValueObject/JobMessages.php | 4 + .../src/ValueObject/JobSettings.php | 24 ++++++ .../ValueObject/KantarWatermarkSettings.php | 26 ++++++ .../src/ValueObject/M2tsScte35Esam.php | 2 + .../src/ValueObject/M2tsSettings.php | 78 +++++++++++++++++ .../src/ValueObject/M3u8Settings.php | 38 +++++++++ .../ValueObject/MinBottomRenditionSize.php | 4 + .../src/ValueObject/MinTopRenditionSize.php | 4 + .../src/ValueObject/MotionImageInserter.php | 12 +++ .../MotionImageInsertionFramerate.php | 4 + .../MotionImageInsertionOffset.php | 4 + .../src/ValueObject/MovSettings.php | 10 +++ .../src/ValueObject/Mp2Settings.php | 6 ++ .../src/ValueObject/Mp3Settings.php | 10 +++ .../src/ValueObject/Mp4Settings.php | 12 +++ .../src/ValueObject/MpdSettings.php | 22 +++++ .../src/ValueObject/Mpeg2Settings.php | 66 +++++++++++++++ .../MsSmoothAdditionalManifest.php | 4 + .../MsSmoothEncryptionSettings.php | 2 + .../src/ValueObject/MsSmoothGroupSettings.php | 16 ++++ .../src/ValueObject/MxfSettings.php | 6 ++ .../ValueObject/MxfXavcProfileSettings.php | 4 + .../NexGuardFileMarkerSettings.php | 8 ++ .../src/ValueObject/NielsenConfiguration.php | 4 + .../NielsenNonLinearWatermarkSettings.php | 22 +++++ .../src/ValueObject/NoiseReducer.php | 8 ++ .../NoiseReducerFilterSettings.php | 2 + .../NoiseReducerSpatialFilterSettings.php | 6 ++ .../NoiseReducerTemporalFilterSettings.php | 10 +++ .../src/ValueObject/OpusSettings.php | 6 ++ .../MediaConvert/src/ValueObject/Output.php | 16 ++++ .../src/ValueObject/OutputChannelMapping.php | 4 + .../src/ValueObject/OutputDetail.php | 4 + .../src/ValueObject/OutputGroup.php | 10 +++ .../src/ValueObject/OutputGroupDetail.php | 2 + .../src/ValueObject/OutputGroupSettings.php | 12 +++ .../src/ValueObject/OutputSettings.php | 2 + .../src/ValueObject/PartnerWatermarking.php | 2 + .../src/ValueObject/ProresSettings.php | 26 ++++++ .../src/ValueObject/QueueTransition.php | 6 ++ .../src/ValueObject/Rectangle.php | 8 ++ .../src/ValueObject/RemixSettings.php | 6 ++ .../S3DestinationAccessControl.php | 2 + .../src/ValueObject/S3DestinationSettings.php | 4 + .../src/ValueObject/S3EncryptionSettings.php | 6 ++ .../ValueObject/SccDestinationSettings.php | 2 + .../src/ValueObject/SpekeKeyProvider.php | 8 ++ .../src/ValueObject/SpekeKeyProviderCmaf.php | 10 +++ .../ValueObject/SrtDestinationSettings.php | 2 + .../src/ValueObject/StaticKeyProvider.php | 8 ++ .../TeletextDestinationSettings.php | 4 + .../ValueObject/TeletextSourceSettings.php | 2 + .../src/ValueObject/TimecodeBurnin.php | 6 ++ .../src/ValueObject/TimecodeConfig.php | 8 ++ .../ValueObject/TimedMetadataInsertion.php | 2 + .../MediaConvert/src/ValueObject/Timing.php | 6 ++ .../src/ValueObject/TrackSourceSettings.php | 2 + .../ValueObject/TtmlDestinationSettings.php | 2 + .../src/ValueObject/Vc3Settings.php | 18 ++++ .../src/ValueObject/VideoCodecSettings.php | 24 ++++++ .../src/ValueObject/VideoDescription.php | 30 +++++++ .../src/ValueObject/VideoDetail.php | 4 + .../src/ValueObject/VideoPreprocessor.php | 16 ++++ .../src/ValueObject/VideoSelector.php | 20 +++++ .../src/ValueObject/VorbisSettings.php | 6 ++ .../src/ValueObject/Vp8Settings.php | 26 ++++++ .../src/ValueObject/Vp9Settings.php | 26 ++++++ .../src/ValueObject/WarningGroup.php | 4 + .../src/ValueObject/WavSettings.php | 8 ++ .../ValueObject/WebvttDestinationSettings.php | 4 + .../ValueObject/WebvttHlsSourceSettings.php | 6 ++ .../Xavc4kIntraCbgProfileSettings.php | 2 + .../Xavc4kIntraVbrProfileSettings.php | 2 + .../src/ValueObject/Xavc4kProfileSettings.php | 16 ++++ .../XavcHdIntraCbgProfileSettings.php | 2 + .../src/ValueObject/XavcHdProfileSettings.php | 18 ++++ .../src/ValueObject/XavcSettings.php | 32 +++++++ .../Exception/StatementTimeoutException.php | 2 + .../Result/BatchExecuteStatementResponse.php | 2 + .../src/Result/BeginTransactionResponse.php | 2 + .../src/Result/CommitTransactionResponse.php | 2 + .../src/Result/ExecuteStatementResponse.php | 10 +++ .../Result/RollbackTransactionResponse.php | 2 + .../src/ValueObject/ArrayValue.php | 10 +++ .../src/ValueObject/ColumnMetadata.php | 28 +++++++ .../RdsDataService/src/ValueObject/Field.php | 14 ++++ .../src/ValueObject/ResultSetOptions.php | 4 + .../src/ValueObject/SqlParameter.php | 6 ++ .../src/ValueObject/UpdateResult.php | 2 + .../HumanLoopQuotaExceededException.php | 6 ++ .../src/Result/CreateCollectionResponse.php | 6 ++ .../src/Result/CreateProjectResponse.php | 2 + .../src/Result/DeleteCollectionResponse.php | 2 + .../src/Result/DeleteProjectResponse.php | 2 + .../src/Result/DetectFacesResponse.php | 4 + .../Result/DetectModerationLabelsResponse.php | 6 ++ .../src/Result/GetCelebrityInfoResponse.php | 6 ++ .../src/Result/IndexFacesResponse.php | 8 ++ .../src/Result/ListCollectionsResponse.php | 6 ++ .../Result/RecognizeCelebritiesResponse.php | 6 ++ .../src/Result/SearchFacesByImageResponse.php | 8 ++ .../Rekognition/src/ValueObject/AgeRange.php | 4 + .../Rekognition/src/ValueObject/Beard.php | 4 + .../src/ValueObject/BoundingBox.php | 8 ++ .../Rekognition/src/ValueObject/Celebrity.php | 13 +++ .../src/ValueObject/ComparedFace.php | 14 ++++ .../Rekognition/src/ValueObject/Emotion.php | 4 + .../src/ValueObject/EyeDirection.php | 6 ++ .../Rekognition/src/ValueObject/EyeOpen.php | 4 + .../src/ValueObject/Eyeglasses.php | 4 + .../Rekognition/src/ValueObject/Face.php | 14 ++++ .../src/ValueObject/FaceDetail.php | 34 ++++++++ .../Rekognition/src/ValueObject/FaceMatch.php | 4 + .../src/ValueObject/FaceOccluded.php | 4 + .../src/ValueObject/FaceRecord.php | 4 + .../Rekognition/src/ValueObject/Gender.php | 4 + .../ValueObject/HumanLoopActivationOutput.php | 6 ++ .../src/ValueObject/HumanLoopConfig.php | 6 ++ .../ValueObject/HumanLoopDataAttributes.php | 2 + .../Rekognition/src/ValueObject/Image.php | 4 + .../src/ValueObject/ImageQuality.php | 4 + .../src/ValueObject/KnownGender.php | 2 + .../Rekognition/src/ValueObject/Landmark.php | 6 ++ .../src/ValueObject/ModerationLabel.php | 6 ++ .../Rekognition/src/ValueObject/MouthOpen.php | 4 + .../Rekognition/src/ValueObject/Mustache.php | 4 + .../Rekognition/src/ValueObject/Pose.php | 6 ++ .../Rekognition/src/ValueObject/S3Object.php | 6 ++ .../Rekognition/src/ValueObject/Smile.php | 4 + .../src/ValueObject/Sunglasses.php | 4 + .../src/ValueObject/UnindexedFace.php | 4 + .../Exception/InvalidChangeBatchException.php | 3 + .../ChangeResourceRecordSetsResponse.php | 2 + .../src/Result/CreateHostedZoneResponse.php | 10 +++ .../src/Result/DeleteHostedZoneResponse.php | 2 + .../Result/ListHostedZonesByNameResponse.php | 14 ++++ .../src/Result/ListHostedZonesResponse.php | 10 +++ .../Result/ListResourceRecordSetsResponse.php | 12 +++ .../Route53/src/ValueObject/AliasTarget.php | 6 ++ .../Route53/src/ValueObject/Change.php | 4 + .../Route53/src/ValueObject/ChangeBatch.php | 4 + .../Route53/src/ValueObject/ChangeInfo.php | 8 ++ .../src/ValueObject/CidrRoutingConfig.php | 4 + .../Route53/src/ValueObject/DelegationSet.php | 6 ++ .../Route53/src/ValueObject/GeoLocation.php | 6 ++ .../Route53/src/ValueObject/HostedZone.php | 12 +++ .../src/ValueObject/HostedZoneConfig.php | 4 + .../Route53/src/ValueObject/LinkedService.php | 4 + .../src/ValueObject/ResourceRecord.php | 2 + .../src/ValueObject/ResourceRecordSet.php | 29 +++++++ src/Service/Route53/src/ValueObject/VPC.php | 5 ++ .../Exception/InvalidObjectStateException.php | 6 ++ .../src/Result/AbortMultipartUploadOutput.php | 3 + .../Result/CompleteMultipartUploadOutput.php | 29 +++++++ .../S3/src/Result/CopyObjectOutput.php | 23 +++++ .../S3/src/Result/CreateBucketOutput.php | 2 + .../Result/CreateMultipartUploadOutput.php | 27 ++++++ .../S3/src/Result/DeleteObjectOutput.php | 7 ++ .../src/Result/DeleteObjectTaggingOutput.php | 2 + .../S3/src/Result/DeleteObjectsOutput.php | 7 ++ .../S3/src/Result/GetBucketCorsOutput.php | 2 + .../src/Result/GetBucketEncryptionOutput.php | 3 + .../S3/src/Result/GetObjectAclOutput.php | 7 ++ src/Service/S3/src/Result/GetObjectOutput.php | 73 ++++++++++++++++ .../S3/src/Result/GetObjectTaggingOutput.php | 4 + .../S3/src/Result/HeadObjectOutput.php | 69 +++++++++++++++ .../S3/src/Result/ListBucketsOutput.php | 4 + .../src/Result/ListMultipartUploadsOutput.php | 27 ++++++ .../S3/src/Result/ListObjectsV2Output.php | 27 ++++++ src/Service/S3/src/Result/ListPartsOutput.php | 31 +++++++ .../S3/src/Result/PutObjectAclOutput.php | 3 + src/Service/S3/src/Result/PutObjectOutput.php | 29 +++++++ .../S3/src/Result/PutObjectTaggingOutput.php | 2 + .../S3/src/Result/UploadPartOutput.php | 23 +++++ .../src/ValueObject/AccessControlPolicy.php | 4 + src/Service/S3/src/ValueObject/AwsObject.php | 14 ++++ src/Service/S3/src/ValueObject/Bucket.php | 4 + .../S3/src/ValueObject/CORSConfiguration.php | 2 + src/Service/S3/src/ValueObject/CORSRule.php | 12 +++ .../S3/src/ValueObject/CommonPrefix.php | 2 + .../ValueObject/CompletedMultipartUpload.php | 2 + .../S3/src/ValueObject/CompletedPart.php | 12 +++ .../S3/src/ValueObject/CopyObjectResult.php | 12 +++ .../ValueObject/CreateBucketConfiguration.php | 2 + src/Service/S3/src/ValueObject/Delete.php | 4 + .../S3/src/ValueObject/DeletedObject.php | 8 ++ src/Service/S3/src/ValueObject/Error.php | 8 ++ src/Service/S3/src/ValueObject/FilterRule.php | 4 + src/Service/S3/src/ValueObject/Grant.php | 4 + src/Service/S3/src/ValueObject/Grantee.php | 10 +++ src/Service/S3/src/ValueObject/Initiator.php | 4 + .../LambdaFunctionConfiguration.php | 10 +++ .../S3/src/ValueObject/MultipartUpload.php | 14 ++++ .../ValueObject/NotificationConfiguration.php | 8 ++ .../NotificationConfigurationFilter.php | 3 + .../S3/src/ValueObject/ObjectIdentifier.php | 4 + src/Service/S3/src/ValueObject/Owner.php | 4 + src/Service/S3/src/ValueObject/Part.php | 16 ++++ .../S3/src/ValueObject/QueueConfiguration.php | 10 +++ .../S3/src/ValueObject/S3KeyFilter.php | 3 + .../ServerSideEncryptionByDefault.php | 4 + .../ServerSideEncryptionConfiguration.php | 2 + .../ValueObject/ServerSideEncryptionRule.php | 4 + src/Service/S3/src/ValueObject/Tag.php | 4 + src/Service/S3/src/ValueObject/Tagging.php | 2 + .../S3/src/ValueObject/TopicConfiguration.php | 10 +++ .../src/Result/CreateScheduleGroupOutput.php | 2 + .../src/Result/CreateScheduleOutput.php | 2 + .../src/Result/GetScheduleGroupOutput.php | 10 +++ .../src/Result/GetScheduleOutput.php | 28 +++++++ .../src/Result/ListScheduleGroupsOutput.php | 4 + .../src/Result/ListSchedulesOutput.php | 4 + .../src/Result/UpdateScheduleOutput.php | 2 + .../src/ValueObject/AwsVpcConfiguration.php | 6 ++ .../CapacityProviderStrategyItem.php | 6 ++ .../src/ValueObject/DeadLetterConfig.php | 2 + .../src/ValueObject/EcsParameters.php | 28 +++++++ .../src/ValueObject/EventBridgeParameters.php | 4 + .../src/ValueObject/FlexibleTimeWindow.php | 4 + .../src/ValueObject/KinesisParameters.php | 2 + .../src/ValueObject/NetworkConfiguration.php | 2 + .../src/ValueObject/PlacementConstraint.php | 4 + .../src/ValueObject/PlacementStrategy.php | 4 + .../Scheduler/src/ValueObject/RetryPolicy.php | 4 + .../SageMakerPipelineParameter.php | 4 + .../SageMakerPipelineParameters.php | 2 + .../src/ValueObject/ScheduleGroupSummary.php | 10 +++ .../src/ValueObject/ScheduleSummary.php | 14 ++++ .../src/ValueObject/SqsParameters.php | 2 + src/Service/Scheduler/src/ValueObject/Tag.php | 4 + .../Scheduler/src/ValueObject/Target.php | 20 +++++ .../src/ValueObject/TargetSummary.php | 2 + .../src/Result/CreateSecretResponse.php | 8 ++ .../src/Result/DeleteSecretResponse.php | 6 ++ .../src/Result/GetSecretValueResponse.php | 14 ++++ .../src/Result/ListSecretsResponse.php | 4 + .../src/Result/PutSecretValueResponse.php | 8 ++ .../src/Result/UpdateSecretResponse.php | 6 ++ .../SecretsManager/src/ValueObject/Filter.php | 4 + .../src/ValueObject/ReplicaRegionType.php | 4 + .../src/ValueObject/ReplicationStatusType.php | 10 +++ .../src/ValueObject/RotationRulesType.php | 6 ++ .../src/ValueObject/SecretListEntry.php | 34 ++++++++ .../SecretsManager/src/ValueObject/Tag.php | 4 + .../Ses/src/Result/SendEmailResponse.php | 2 + src/Service/Ses/src/ValueObject/Body.php | 4 + src/Service/Ses/src/ValueObject/Content.php | 4 + .../Ses/src/ValueObject/Destination.php | 6 ++ .../Ses/src/ValueObject/EmailContent.php | 6 ++ .../src/ValueObject/ListManagementOptions.php | 4 + src/Service/Ses/src/ValueObject/Message.php | 4 + .../Ses/src/ValueObject/MessageTag.php | 4 + .../Ses/src/ValueObject/RawMessage.php | 2 + src/Service/Ses/src/ValueObject/Template.php | 6 ++ .../Sns/src/Result/CreateEndpointResponse.php | 2 + .../Sns/src/Result/CreateTopicResponse.php | 2 + .../ListSubscriptionsByTopicResponse.php | 4 + .../Sns/src/Result/PublishBatchResponse.php | 4 + .../Sns/src/Result/PublishResponse.php | 4 + .../Sns/src/Result/SubscribeResponse.php | 2 + .../src/ValueObject/BatchResultErrorEntry.php | 8 ++ .../src/ValueObject/MessageAttributeValue.php | 6 ++ .../ValueObject/PublishBatchRequestEntry.php | 14 ++++ .../ValueObject/PublishBatchResultEntry.php | 6 ++ .../Sns/src/ValueObject/Subscription.php | 10 +++ src/Service/Sns/src/ValueObject/Tag.php | 4 + .../ChangeMessageVisibilityBatchResult.php | 4 + .../Sqs/src/Result/CreateQueueResult.php | 2 + .../src/Result/DeleteMessageBatchResult.php | 4 + .../src/Result/GetQueueAttributesResult.php | 2 + .../Sqs/src/Result/GetQueueUrlResult.php | 2 + .../Sqs/src/Result/ListQueuesResult.php | 4 + .../Sqs/src/Result/ReceiveMessageResult.php | 2 + .../Sqs/src/Result/SendMessageBatchResult.php | 4 + .../Sqs/src/Result/SendMessageResult.php | 10 +++ .../src/ValueObject/BatchResultErrorEntry.php | 8 ++ ...angeMessageVisibilityBatchRequestEntry.php | 6 ++ ...hangeMessageVisibilityBatchResultEntry.php | 2 + .../DeleteMessageBatchRequestEntry.php | 4 + .../DeleteMessageBatchResultEntry.php | 2 + src/Service/Sqs/src/ValueObject/Message.php | 14 ++++ .../src/ValueObject/MessageAttributeValue.php | 10 +++ .../MessageSystemAttributeValue.php | 10 +++ .../SendMessageBatchRequestEntry.php | 14 ++++ .../SendMessageBatchResultEntry.php | 12 +++ .../Ssm/src/Result/DeleteParametersResult.php | 4 + .../Ssm/src/Result/GetParameterResult.php | 2 + .../src/Result/GetParametersByPathResult.php | 4 + .../Ssm/src/Result/GetParametersResult.php | 4 + .../Ssm/src/Result/PutParameterResult.php | 4 + src/Service/Ssm/src/ValueObject/Parameter.php | 18 ++++ .../src/ValueObject/ParameterStringFilter.php | 6 ++ src/Service/Ssm/src/ValueObject/Tag.php | 4 + .../src/Exception/ValidationException.php | 2 + .../src/Result/StartExecutionOutput.php | 4 + .../src/Result/StopExecutionOutput.php | 2 + .../src/Result/CancelQueryResponse.php | 2 + .../src/Result/DescribeEndpointsResponse.php | 2 + .../src/Result/PrepareQueryResponse.php | 6 ++ .../src/Result/QueryResponse.php | 10 +++ .../src/ValueObject/ColumnInfo.php | 4 + .../TimestreamQuery/src/ValueObject/Datum.php | 10 +++ .../src/ValueObject/Endpoint.php | 4 + .../src/ValueObject/ParameterMapping.php | 5 ++ .../src/ValueObject/QueryStatus.php | 6 ++ .../TimestreamQuery/src/ValueObject/Row.php | 2 + .../src/ValueObject/SelectColumn.php | 11 +++ .../src/ValueObject/TimeSeriesDataPoint.php | 4 + .../TimestreamQuery/src/ValueObject/Type.php | 8 ++ .../Exception/RejectedRecordsException.php | 3 + .../src/Result/DescribeEndpointsResponse.php | 2 + .../src/Result/WriteRecordsResponse.php | 2 + .../src/ValueObject/Dimension.php | 6 ++ .../src/ValueObject/Endpoint.php | 4 + .../src/ValueObject/MeasureValue.php | 6 ++ .../src/ValueObject/Record.php | 16 ++++ .../src/ValueObject/RecordsIngested.php | 6 ++ .../src/ValueObject/RejectedRecord.php | 6 ++ ...DetectedLanguageLowConfidenceException.php | 2 + .../UnsupportedLanguagePairException.php | 4 + .../src/Result/TranslateTextResponse.php | 10 +++ .../src/ValueObject/AppliedTerminology.php | 4 + .../Translate/src/ValueObject/Term.php | 4 + .../src/ValueObject/TranslationSettings.php | 4 + .../src/Result/PutTraceSegmentsResult.php | 2 + .../ValueObject/UnprocessedTraceSegment.php | 6 ++ 877 files changed, 7053 insertions(+), 1 deletion(-) diff --git a/psalm.baseline.xml b/psalm.baseline.xml index 4b24e1518..c87cabdfb 100644 --- a/psalm.baseline.xml +++ b/psalm.baseline.xml @@ -288,6 +288,11 @@ ]]> + + + + + $items @@ -307,4 +312,14 @@ empty($s3SignerOptions) + + + + + + + + + + diff --git a/src/CodeGenerator/src/Generator/CodeGenerator/PopulatorGenerator.php b/src/CodeGenerator/src/Generator/CodeGenerator/PopulatorGenerator.php index e7ef8edd7..372573938 100644 --- a/src/CodeGenerator/src/Generator/CodeGenerator/PopulatorGenerator.php +++ b/src/CodeGenerator/src/Generator/CodeGenerator/PopulatorGenerator.php @@ -132,8 +132,9 @@ private function generateProperties(StructureShape $shape, ClassBuilder $classBu $nullable = false; } elseif ($member->isStreaming()) { $returnType = ResultStream::class; - $parameterType = ResultStream::class; + $parameterType = 'ResultStream'; $memberClassNames = []; + $classBuilder->addUse(ResultStream::class); $nullable = false; } @@ -160,6 +161,9 @@ private function generateProperties(StructureShape $shape, ClassBuilder $classBu $method->addComment('@return ' . $parameterType . ($nullable ? '|null' : '')); } $method->setReturnNullable($nullable); + if ($parameterType) { + $property->addComment('@var ' . $parameterType . ($nullable ? '|null' : '')); + } } if ($forEndpoint) { diff --git a/src/CodeGenerator/src/Generator/ObjectGenerator.php b/src/CodeGenerator/src/Generator/ObjectGenerator.php index 878d851c7..4d3b78048 100644 --- a/src/CodeGenerator/src/Generator/ObjectGenerator.php +++ b/src/CodeGenerator/src/Generator/ObjectGenerator.php @@ -342,6 +342,9 @@ private function addProperties(StructureShape $shape, ClassBuilder $classBuilder $method->addComment('@return ' . $parameterType . ($getterSetterNullable ? '|null' : '')); } $method->setReturnNullable($getterSetterNullable); + if ($parameterType) { + $property->addComment('@var ' . $parameterType . ($nullable ? '|null' : '')); + } } foreach ($forEndpointProps as $key => $ok) { diff --git a/src/Core/src/Sts/Result/AssumeRoleResponse.php b/src/Core/src/Sts/Result/AssumeRoleResponse.php index 90946da88..cb4ac1cd2 100644 --- a/src/Core/src/Sts/Result/AssumeRoleResponse.php +++ b/src/Core/src/Sts/Result/AssumeRoleResponse.php @@ -19,6 +19,8 @@ class AssumeRoleResponse extends Result * * > The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no * > assumptions about the maximum size. + * + * @var Credentials|null */ private $credentials; @@ -27,6 +29,8 @@ class AssumeRoleResponse extends Result * resulting temporary security credentials. For example, you can reference these credentials as a principal in a * resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you * specified when you called `AssumeRole`. + * + * @var AssumedRoleUser|null */ private $assumedRoleUser; @@ -34,6 +38,8 @@ class AssumeRoleResponse extends Result * A percentage value that indicates the packed size of the session policies and session tags combined passed in the * request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded * the allowed space. + * + * @var int|null */ private $packedPolicySize; @@ -50,6 +56,8 @@ class AssumeRoleResponse extends Result * characters with no spaces. You can also include underscores or any of the following characters: =,.@- * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html + * + * @var string|null */ private $sourceIdentity; diff --git a/src/Core/src/Sts/Result/AssumeRoleWithWebIdentityResponse.php b/src/Core/src/Sts/Result/AssumeRoleWithWebIdentityResponse.php index ad7d8d1a6..6eb109477 100644 --- a/src/Core/src/Sts/Result/AssumeRoleWithWebIdentityResponse.php +++ b/src/Core/src/Sts/Result/AssumeRoleWithWebIdentityResponse.php @@ -18,6 +18,8 @@ class AssumeRoleWithWebIdentityResponse extends Result * * > The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no * > assumptions about the maximum size. + * + * @var Credentials|null */ private $credentials; @@ -26,6 +28,8 @@ class AssumeRoleWithWebIdentityResponse extends Result * `WebIdentityToken` that was submitted with the `AssumeRoleWithWebIdentity` call. The identifier is typically unique * to the user and the application that acquired the `WebIdentityToken` (pairwise identifier). For OpenID Connect ID * tokens, this field contains the value returned by the identity provider as the token's `sub` (Subject) claim. + * + * @var string|null */ private $subjectFromWebIdentityToken; @@ -34,6 +38,8 @@ class AssumeRoleWithWebIdentityResponse extends Result * resulting temporary security credentials. For example, you can reference these credentials as a principal in a * resource-based policy by using the ARN or assumed role ID. The ARN and ID include the `RoleSessionName` that you * specified when you called `AssumeRole`. + * + * @var AssumedRoleUser|null */ private $assumedRoleUser; @@ -41,6 +47,8 @@ class AssumeRoleWithWebIdentityResponse extends Result * A percentage value that indicates the packed size of the session policies and session tags combined passed in the * request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded * the allowed space. + * + * @var int|null */ private $packedPolicySize; @@ -48,12 +56,16 @@ class AssumeRoleWithWebIdentityResponse extends Result * The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of * the `iss` field. For OAuth 2.0 access tokens, this contains the value of the `ProviderId` parameter that was passed * in the `AssumeRoleWithWebIdentity` request. + * + * @var string|null */ private $provider; /** * The intended audience (also known as client ID) of the web identity token. This is traditionally the client * identifier issued to the application that requested the web identity token. + * + * @var string|null */ private $audience; @@ -76,6 +88,8 @@ class AssumeRoleWithWebIdentityResponse extends Result * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining * [^2]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html * [^3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html + * + * @var string|null */ private $sourceIdentity; diff --git a/src/Core/src/Sts/Result/GetCallerIdentityResponse.php b/src/Core/src/Sts/Result/GetCallerIdentityResponse.php index ce1338853..1be671113 100644 --- a/src/Core/src/Sts/Result/GetCallerIdentityResponse.php +++ b/src/Core/src/Sts/Result/GetCallerIdentityResponse.php @@ -17,16 +17,22 @@ class GetCallerIdentityResponse extends Result * Variables** reference page in the *IAM User Guide*. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable + * + * @var string|null */ private $userId; /** * The Amazon Web Services account ID number of the account that owns or contains the calling entity. + * + * @var string|null */ private $account; /** * The Amazon Web Services ARN associated with the calling entity. + * + * @var string|null */ private $arn; diff --git a/src/Core/src/Sts/ValueObject/AssumedRoleUser.php b/src/Core/src/Sts/ValueObject/AssumedRoleUser.php index 6b261f445..e543d9990 100644 --- a/src/Core/src/Sts/ValueObject/AssumedRoleUser.php +++ b/src/Core/src/Sts/ValueObject/AssumedRoleUser.php @@ -12,6 +12,8 @@ final class AssumedRoleUser /** * A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role * ID is generated by Amazon Web Services when the role is created. + * + * @var string */ private $assumedRoleId; @@ -20,6 +22,8 @@ final class AssumedRoleUser * about ARNs and how to use them in policies, see IAM Identifiers [^1] in the *IAM User Guide*. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html + * + * @var string */ private $arn; diff --git a/src/Core/src/Sts/ValueObject/Credentials.php b/src/Core/src/Sts/ValueObject/Credentials.php index 74e316dc4..93cabc9fe 100644 --- a/src/Core/src/Sts/ValueObject/Credentials.php +++ b/src/Core/src/Sts/ValueObject/Credentials.php @@ -11,21 +11,29 @@ final class Credentials { /** * The access key ID that identifies the temporary security credentials. + * + * @var string */ private $accessKeyId; /** * The secret access key that can be used to sign requests. + * + * @var string */ private $secretAccessKey; /** * The token that users must pass to the service API to use the temporary credentials. + * + * @var string */ private $sessionToken; /** * The date on which the current credentials expire. + * + * @var \DateTimeImmutable */ private $expiration; diff --git a/src/Core/src/Sts/ValueObject/PolicyDescriptorType.php b/src/Core/src/Sts/ValueObject/PolicyDescriptorType.php index acc2f8987..434ea3462 100644 --- a/src/Core/src/Sts/ValueObject/PolicyDescriptorType.php +++ b/src/Core/src/Sts/ValueObject/PolicyDescriptorType.php @@ -14,6 +14,8 @@ final class PolicyDescriptorType * *Amazon Web Services General Reference*. * * [^1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + * + * @var string|null */ private $arn; diff --git a/src/Core/src/Sts/ValueObject/Tag.php b/src/Core/src/Sts/ValueObject/Tag.php index d6791e459..3ac064b40 100644 --- a/src/Core/src/Sts/ValueObject/Tag.php +++ b/src/Core/src/Sts/ValueObject/Tag.php @@ -20,6 +20,8 @@ final class Tag * additional limits, see IAM and STS Character Limits [^1] in the *IAM User Guide*. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length + * + * @var string */ private $key; @@ -30,6 +32,8 @@ final class Tag * additional limits, see IAM and STS Character Limits [^1] in the *IAM User Guide*. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length + * + * @var string */ private $value; diff --git a/src/Service/AppSync/src/Exception/BadRequestException.php b/src/Service/AppSync/src/Exception/BadRequestException.php index 3d3264a99..d350c52d4 100644 --- a/src/Service/AppSync/src/Exception/BadRequestException.php +++ b/src/Service/AppSync/src/Exception/BadRequestException.php @@ -15,8 +15,14 @@ */ final class BadRequestException extends ClientException { + /** + * @var BadRequestReason::*|null + */ private $reason; + /** + * @var BadRequestDetail|null + */ private $detail; public function getDetail(): ?BadRequestDetail diff --git a/src/Service/AppSync/src/Result/CreateResolverResponse.php b/src/Service/AppSync/src/Result/CreateResolverResponse.php index 9dea3cdc0..0f40ad1c5 100644 --- a/src/Service/AppSync/src/Result/CreateResolverResponse.php +++ b/src/Service/AppSync/src/Result/CreateResolverResponse.php @@ -15,6 +15,8 @@ class CreateResolverResponse extends Result { /** * The `Resolver` object. + * + * @var Resolver|null */ private $resolver; diff --git a/src/Service/AppSync/src/Result/GetSchemaCreationStatusResponse.php b/src/Service/AppSync/src/Result/GetSchemaCreationStatusResponse.php index f4d8a85ec..2e22f5e2d 100644 --- a/src/Service/AppSync/src/Result/GetSchemaCreationStatusResponse.php +++ b/src/Service/AppSync/src/Result/GetSchemaCreationStatusResponse.php @@ -11,11 +11,15 @@ class GetSchemaCreationStatusResponse extends Result /** * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE * state, you can add data. + * + * @var SchemaStatus::*|null */ private $status; /** * Detailed information about the status of the schema creation operation. + * + * @var string|null */ private $details; diff --git a/src/Service/AppSync/src/Result/ListApiKeysResponse.php b/src/Service/AppSync/src/Result/ListApiKeysResponse.php index 6a0710705..334b01b11 100644 --- a/src/Service/AppSync/src/Result/ListApiKeysResponse.php +++ b/src/Service/AppSync/src/Result/ListApiKeysResponse.php @@ -10,11 +10,15 @@ class ListApiKeysResponse extends Result { /** * The `ApiKey` objects. + * + * @var ApiKey[] */ private $apiKeys; /** * An identifier to pass in the next request to this operation to return the next set of items in the list. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/AppSync/src/Result/ListResolversResponse.php b/src/Service/AppSync/src/Result/ListResolversResponse.php index ba187e7b7..f303b2920 100644 --- a/src/Service/AppSync/src/Result/ListResolversResponse.php +++ b/src/Service/AppSync/src/Result/ListResolversResponse.php @@ -15,11 +15,15 @@ class ListResolversResponse extends Result { /** * The `Resolver` objects. + * + * @var Resolver[] */ private $resolvers; /** * An identifier to pass in the next request to this operation to return the next set of items in the list. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/AppSync/src/Result/StartSchemaCreationResponse.php b/src/Service/AppSync/src/Result/StartSchemaCreationResponse.php index 8b7490d81..8b14e4a1f 100644 --- a/src/Service/AppSync/src/Result/StartSchemaCreationResponse.php +++ b/src/Service/AppSync/src/Result/StartSchemaCreationResponse.php @@ -11,6 +11,8 @@ class StartSchemaCreationResponse extends Result /** * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE * state, you can add data. + * + * @var SchemaStatus::*|null */ private $status; diff --git a/src/Service/AppSync/src/Result/UpdateApiKeyResponse.php b/src/Service/AppSync/src/Result/UpdateApiKeyResponse.php index a0f30ec86..697a71445 100644 --- a/src/Service/AppSync/src/Result/UpdateApiKeyResponse.php +++ b/src/Service/AppSync/src/Result/UpdateApiKeyResponse.php @@ -10,6 +10,8 @@ class UpdateApiKeyResponse extends Result { /** * The API key. + * + * @var ApiKey|null */ private $apiKey; diff --git a/src/Service/AppSync/src/Result/UpdateDataSourceResponse.php b/src/Service/AppSync/src/Result/UpdateDataSourceResponse.php index e7aad55ca..24c322c58 100644 --- a/src/Service/AppSync/src/Result/UpdateDataSourceResponse.php +++ b/src/Service/AppSync/src/Result/UpdateDataSourceResponse.php @@ -21,6 +21,8 @@ class UpdateDataSourceResponse extends Result { /** * The updated `DataSource` object. + * + * @var DataSource|null */ private $dataSource; diff --git a/src/Service/AppSync/src/Result/UpdateResolverResponse.php b/src/Service/AppSync/src/Result/UpdateResolverResponse.php index e256fbb6c..44e8d2428 100644 --- a/src/Service/AppSync/src/Result/UpdateResolverResponse.php +++ b/src/Service/AppSync/src/Result/UpdateResolverResponse.php @@ -15,6 +15,8 @@ class UpdateResolverResponse extends Result { /** * The updated `Resolver` object. + * + * @var Resolver|null */ private $resolver; diff --git a/src/Service/AppSync/src/ValueObject/ApiKey.php b/src/Service/AppSync/src/ValueObject/ApiKey.php index 64594120d..d111bd42a 100644 --- a/src/Service/AppSync/src/ValueObject/ApiKey.php +++ b/src/Service/AppSync/src/ValueObject/ApiKey.php @@ -36,23 +36,31 @@ final class ApiKey { /** * The API key ID. + * + * @var string|null */ private $id; /** * A description of the purpose of the API key. + * + * @var string|null */ private $description; /** * The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the * nearest hour. + * + * @var int|null */ private $expires; /** * The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the * nearest hour. + * + * @var int|null */ private $deletes; diff --git a/src/Service/AppSync/src/ValueObject/AppSyncRuntime.php b/src/Service/AppSync/src/ValueObject/AppSyncRuntime.php index e6bda58bc..d9147f6f0 100644 --- a/src/Service/AppSync/src/ValueObject/AppSyncRuntime.php +++ b/src/Service/AppSync/src/ValueObject/AppSyncRuntime.php @@ -14,11 +14,15 @@ final class AppSyncRuntime { /** * The `name` of the runtime to use. Currently, the only allowed value is `APPSYNC_JS`. + * + * @var RuntimeName::* */ private $name; /** * The `version` of the runtime to use. Currently, the only allowed version is `1.0.0`. + * + * @var string */ private $runtimeVersion; diff --git a/src/Service/AppSync/src/ValueObject/AuthorizationConfig.php b/src/Service/AppSync/src/ValueObject/AuthorizationConfig.php index 037384773..27ee4572a 100644 --- a/src/Service/AppSync/src/ValueObject/AuthorizationConfig.php +++ b/src/Service/AppSync/src/ValueObject/AuthorizationConfig.php @@ -14,11 +14,15 @@ final class AuthorizationConfig * The authorization type that the HTTP endpoint requires. * * - **AWS_IAM**: The authorization type is Signature Version 4 (SigV4). + * + * @var AuthorizationType::* */ private $authorizationType; /** * The Identity and Access Management (IAM) settings. + * + * @var AwsIamConfig|null */ private $awsIamConfig; diff --git a/src/Service/AppSync/src/ValueObject/AwsIamConfig.php b/src/Service/AppSync/src/ValueObject/AwsIamConfig.php index 6ac13e9b7..7dd774379 100644 --- a/src/Service/AppSync/src/ValueObject/AwsIamConfig.php +++ b/src/Service/AppSync/src/ValueObject/AwsIamConfig.php @@ -9,11 +9,15 @@ final class AwsIamConfig { /** * The signing Amazon Web Services Region for IAM authorization. + * + * @var string|null */ private $signingRegion; /** * The signing service name for IAM authorization. + * + * @var string|null */ private $signingServiceName; diff --git a/src/Service/AppSync/src/ValueObject/BadRequestDetail.php b/src/Service/AppSync/src/ValueObject/BadRequestDetail.php index d1f939944..d517a4bd8 100644 --- a/src/Service/AppSync/src/ValueObject/BadRequestDetail.php +++ b/src/Service/AppSync/src/ValueObject/BadRequestDetail.php @@ -10,6 +10,8 @@ final class BadRequestDetail { /** * Contains the list of errors in the request. + * + * @var CodeError[]|null */ private $codeErrors; diff --git a/src/Service/AppSync/src/ValueObject/CachingConfig.php b/src/Service/AppSync/src/ValueObject/CachingConfig.php index 4c7f0078a..6d28aa8a3 100644 --- a/src/Service/AppSync/src/ValueObject/CachingConfig.php +++ b/src/Service/AppSync/src/ValueObject/CachingConfig.php @@ -13,6 +13,8 @@ final class CachingConfig * The TTL in seconds for a resolver that has caching activated. * * Valid values are 1–3,600 seconds. + * + * @var int */ private $ttl; @@ -20,6 +22,8 @@ final class CachingConfig * The caching keys for a resolver that has caching activated. * * Valid values are entries from the `$context.arguments`, `$context.source`, and `$context.identity` maps. + * + * @var string[]|null */ private $cachingKeys; diff --git a/src/Service/AppSync/src/ValueObject/CodeError.php b/src/Service/AppSync/src/ValueObject/CodeError.php index 86b30ea78..2c378dbac 100644 --- a/src/Service/AppSync/src/ValueObject/CodeError.php +++ b/src/Service/AppSync/src/ValueObject/CodeError.php @@ -11,6 +11,8 @@ final class CodeError * The type of code error. * * Examples include, but aren't limited to: `LINT_ERROR`, `PARSER_ERROR`. + * + * @var string|null */ private $errorType; @@ -18,11 +20,15 @@ final class CodeError * A user presentable error. * * Examples include, but aren't limited to: `Parsing error: Unterminated string literal`. + * + * @var string|null */ private $value; /** * The line, column, and span location of the error in the code. + * + * @var CodeErrorLocation|null */ private $location; diff --git a/src/Service/AppSync/src/ValueObject/CodeErrorLocation.php b/src/Service/AppSync/src/ValueObject/CodeErrorLocation.php index b1bc0b71c..e8f198699 100644 --- a/src/Service/AppSync/src/ValueObject/CodeErrorLocation.php +++ b/src/Service/AppSync/src/ValueObject/CodeErrorLocation.php @@ -9,16 +9,22 @@ final class CodeErrorLocation { /** * The line number in the code. Defaults to `0` if unknown. + * + * @var int|null */ private $line; /** * The column number in the code. Defaults to `0` if unknown. + * + * @var int|null */ private $column; /** * The span/length of the error. Defaults to `-1` if unknown. + * + * @var int|null */ private $span; diff --git a/src/Service/AppSync/src/ValueObject/DataSource.php b/src/Service/AppSync/src/ValueObject/DataSource.php index df38c7099..ea0edcc29 100644 --- a/src/Service/AppSync/src/ValueObject/DataSource.php +++ b/src/Service/AppSync/src/ValueObject/DataSource.php @@ -11,16 +11,22 @@ final class DataSource { /** * The data source Amazon Resource Name (ARN). + * + * @var string|null */ private $dataSourceArn; /** * The name of the data source. + * + * @var string|null */ private $name; /** * The description of the data source. + * + * @var string|null */ private $description; @@ -37,47 +43,65 @@ final class DataSource * mutation. * - **HTTP**: The data source is an HTTP endpoint. * - **RELATIONAL_DATABASE**: The data source is a relational database. + * + * @var DataSourceType::*|null */ private $type; /** * The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system * assumes this role when accessing the data source. + * + * @var string|null */ private $serviceRoleArn; /** * DynamoDB settings. + * + * @var DynamodbDataSourceConfig|null */ private $dynamodbConfig; /** * Lambda settings. + * + * @var LambdaDataSourceConfig|null */ private $lambdaConfig; /** * Amazon OpenSearch Service settings. + * + * @var ElasticsearchDataSourceConfig|null */ private $elasticsearchConfig; /** * Amazon OpenSearch Service settings. + * + * @var OpenSearchServiceDataSourceConfig|null */ private $openSearchServiceConfig; /** * HTTP endpoint settings. + * + * @var HttpDataSourceConfig|null */ private $httpConfig; /** * Relational database settings. + * + * @var RelationalDatabaseDataSourceConfig|null */ private $relationalDatabaseConfig; /** * Amazon EventBridge settings. + * + * @var EventBridgeDataSourceConfig|null */ private $eventBridgeConfig; diff --git a/src/Service/AppSync/src/ValueObject/DeltaSyncConfig.php b/src/Service/AppSync/src/ValueObject/DeltaSyncConfig.php index f5ccfa3da..eea0263bb 100644 --- a/src/Service/AppSync/src/ValueObject/DeltaSyncConfig.php +++ b/src/Service/AppSync/src/ValueObject/DeltaSyncConfig.php @@ -9,16 +9,22 @@ final class DeltaSyncConfig { /** * The number of minutes that an Item is stored in the data source. + * + * @var int|null */ private $baseTableTtl; /** * The Delta Sync table name. + * + * @var string|null */ private $deltaSyncTableName; /** * The number of minutes that a Delta Sync log entry is stored in the Delta Sync table. + * + * @var int|null */ private $deltaSyncTableTtl; diff --git a/src/Service/AppSync/src/ValueObject/DynamodbDataSourceConfig.php b/src/Service/AppSync/src/ValueObject/DynamodbDataSourceConfig.php index ce718eebe..9a0e52d87 100644 --- a/src/Service/AppSync/src/ValueObject/DynamodbDataSourceConfig.php +++ b/src/Service/AppSync/src/ValueObject/DynamodbDataSourceConfig.php @@ -11,26 +11,36 @@ final class DynamodbDataSourceConfig { /** * The table name. + * + * @var string */ private $tableName; /** * The Amazon Web Services Region. + * + * @var string */ private $awsRegion; /** * Set to TRUE to use Amazon Cognito credentials with this data source. + * + * @var bool|null */ private $useCallerCredentials; /** * The `DeltaSyncConfig` for a versioned data source. + * + * @var DeltaSyncConfig|null */ private $deltaSyncConfig; /** * Set to TRUE to use Conflict Detection and Resolution with this data source. + * + * @var bool|null */ private $versioned; diff --git a/src/Service/AppSync/src/ValueObject/ElasticsearchDataSourceConfig.php b/src/Service/AppSync/src/ValueObject/ElasticsearchDataSourceConfig.php index 33f72ddbd..081eba20d 100644 --- a/src/Service/AppSync/src/ValueObject/ElasticsearchDataSourceConfig.php +++ b/src/Service/AppSync/src/ValueObject/ElasticsearchDataSourceConfig.php @@ -14,11 +14,15 @@ final class ElasticsearchDataSourceConfig { /** * The endpoint. + * + * @var string */ private $endpoint; /** * The Amazon Web Services Region. + * + * @var string */ private $awsRegion; diff --git a/src/Service/AppSync/src/ValueObject/EventBridgeDataSourceConfig.php b/src/Service/AppSync/src/ValueObject/EventBridgeDataSourceConfig.php index 6ef78a7d9..2e46d4342 100644 --- a/src/Service/AppSync/src/ValueObject/EventBridgeDataSourceConfig.php +++ b/src/Service/AppSync/src/ValueObject/EventBridgeDataSourceConfig.php @@ -13,6 +13,8 @@ final class EventBridgeDataSourceConfig * The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses [^1]. * * [^1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html + * + * @var string */ private $eventBusArn; diff --git a/src/Service/AppSync/src/ValueObject/HttpDataSourceConfig.php b/src/Service/AppSync/src/ValueObject/HttpDataSourceConfig.php index a1d4509b4..5ec584e5d 100644 --- a/src/Service/AppSync/src/ValueObject/HttpDataSourceConfig.php +++ b/src/Service/AppSync/src/ValueObject/HttpDataSourceConfig.php @@ -11,11 +11,15 @@ final class HttpDataSourceConfig * The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be * HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for * HTTPS endpoints. + * + * @var string|null */ private $endpoint; /** * The authorization configuration in case the HTTP endpoint requires authorization. + * + * @var AuthorizationConfig|null */ private $authorizationConfig; diff --git a/src/Service/AppSync/src/ValueObject/LambdaConflictHandlerConfig.php b/src/Service/AppSync/src/ValueObject/LambdaConflictHandlerConfig.php index 61b419a1a..1fa1108fe 100644 --- a/src/Service/AppSync/src/ValueObject/LambdaConflictHandlerConfig.php +++ b/src/Service/AppSync/src/ValueObject/LambdaConflictHandlerConfig.php @@ -9,6 +9,8 @@ final class LambdaConflictHandlerConfig { /** * The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. + * + * @var string|null */ private $lambdaConflictHandlerArn; diff --git a/src/Service/AppSync/src/ValueObject/LambdaDataSourceConfig.php b/src/Service/AppSync/src/ValueObject/LambdaDataSourceConfig.php index fc6151f7e..42a34e75a 100644 --- a/src/Service/AppSync/src/ValueObject/LambdaDataSourceConfig.php +++ b/src/Service/AppSync/src/ValueObject/LambdaDataSourceConfig.php @@ -11,6 +11,8 @@ final class LambdaDataSourceConfig { /** * The Amazon Resource Name (ARN) for the Lambda function. + * + * @var string */ private $lambdaFunctionArn; diff --git a/src/Service/AppSync/src/ValueObject/OpenSearchServiceDataSourceConfig.php b/src/Service/AppSync/src/ValueObject/OpenSearchServiceDataSourceConfig.php index 2ae215318..ab40e12f8 100644 --- a/src/Service/AppSync/src/ValueObject/OpenSearchServiceDataSourceConfig.php +++ b/src/Service/AppSync/src/ValueObject/OpenSearchServiceDataSourceConfig.php @@ -11,11 +11,15 @@ final class OpenSearchServiceDataSourceConfig { /** * The endpoint. + * + * @var string */ private $endpoint; /** * The Amazon Web Services Region. + * + * @var string */ private $awsRegion; diff --git a/src/Service/AppSync/src/ValueObject/PipelineConfig.php b/src/Service/AppSync/src/ValueObject/PipelineConfig.php index f9e06cf3a..6147ce7bb 100644 --- a/src/Service/AppSync/src/ValueObject/PipelineConfig.php +++ b/src/Service/AppSync/src/ValueObject/PipelineConfig.php @@ -9,6 +9,8 @@ final class PipelineConfig { /** * A list of `Function` objects. + * + * @var string[]|null */ private $functions; diff --git a/src/Service/AppSync/src/ValueObject/RdsHttpEndpointConfig.php b/src/Service/AppSync/src/ValueObject/RdsHttpEndpointConfig.php index 4c46b51ec..d6fcba79b 100644 --- a/src/Service/AppSync/src/ValueObject/RdsHttpEndpointConfig.php +++ b/src/Service/AppSync/src/ValueObject/RdsHttpEndpointConfig.php @@ -9,26 +9,36 @@ final class RdsHttpEndpointConfig { /** * Amazon Web Services Region for Amazon RDS HTTP endpoint. + * + * @var string|null */ private $awsRegion; /** * Amazon RDS cluster Amazon Resource Name (ARN). + * + * @var string|null */ private $dbClusterIdentifier; /** * Logical database name. + * + * @var string|null */ private $databaseName; /** * Logical schema name. + * + * @var string|null */ private $schema; /** * Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials. + * + * @var string|null */ private $awsSecretStoreArn; diff --git a/src/Service/AppSync/src/ValueObject/RelationalDatabaseDataSourceConfig.php b/src/Service/AppSync/src/ValueObject/RelationalDatabaseDataSourceConfig.php index b86e5f239..67e1d724f 100644 --- a/src/Service/AppSync/src/ValueObject/RelationalDatabaseDataSourceConfig.php +++ b/src/Service/AppSync/src/ValueObject/RelationalDatabaseDataSourceConfig.php @@ -15,11 +15,15 @@ final class RelationalDatabaseDataSourceConfig * * - **RDS_HTTP_ENDPOINT**: The relational database source type is an Amazon Relational Database Service (Amazon RDS) * HTTP endpoint. + * + * @var RelationalDatabaseSourceType::*|null */ private $relationalDatabaseSourceType; /** * Amazon RDS HTTP endpoint settings. + * + * @var RdsHttpEndpointConfig|null */ private $rdsHttpEndpointConfig; diff --git a/src/Service/AppSync/src/ValueObject/Resolver.php b/src/Service/AppSync/src/ValueObject/Resolver.php index 6546f3aed..fd183f77e 100644 --- a/src/Service/AppSync/src/ValueObject/Resolver.php +++ b/src/Service/AppSync/src/ValueObject/Resolver.php @@ -11,31 +11,43 @@ final class Resolver { /** * The resolver type name. + * + * @var string|null */ private $typeName; /** * The resolver field name. + * + * @var string|null */ private $fieldName; /** * The resolver data source name. + * + * @var string|null */ private $dataSourceName; /** * The resolver Amazon Resource Name (ARN). + * + * @var string|null */ private $resolverArn; /** * The request mapping template. + * + * @var string|null */ private $requestMappingTemplate; /** * The response mapping template. + * + * @var string|null */ private $responseMappingTemplate; @@ -46,34 +58,49 @@ final class Resolver * GraphQL query against a single data source. * - **PIPELINE**: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of `Function` objects in * a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. + * + * @var ResolverKind::*|null */ private $kind; /** * The `PipelineConfig`. + * + * @var PipelineConfig|null */ private $pipelineConfig; /** * The `SyncConfig` for a resolver attached to a versioned data source. + * + * @var SyncConfig|null */ private $syncConfig; /** * The caching configuration for the resolver. + * + * @var CachingConfig|null */ private $cachingConfig; /** * The maximum batching size for a resolver. + * + * @var int|null */ private $maxBatchSize; + /** + * @var AppSyncRuntime|null + */ private $runtime; /** * The `resolver` code that contains the request and response functions. When code is used, the `runtime` is required. * The `runtime` value must be `APPSYNC_JS`. + * + * @var string|null */ private $code; diff --git a/src/Service/AppSync/src/ValueObject/SyncConfig.php b/src/Service/AppSync/src/ValueObject/SyncConfig.php index dc2939c20..29b8489ff 100644 --- a/src/Service/AppSync/src/ValueObject/SyncConfig.php +++ b/src/Service/AppSync/src/ValueObject/SyncConfig.php @@ -20,6 +20,8 @@ final class SyncConfig * at the server. * - **AUTOMERGE**: Resolve conflicts with the Automerge conflict resolution strategy. * - **LAMBDA**: Resolve conflicts with an Lambda function supplied in the `LambdaConflictHandlerConfig`. + * + * @var ConflictHandlerType::*|null */ private $conflictHandler; @@ -28,11 +30,15 @@ final class SyncConfig * * - **VERSION**: Detect conflicts based on object versions for this resolver. * - **NONE**: Do not detect conflicts when invoking this resolver. + * + * @var ConflictDetectionType::*|null */ private $conflictDetection; /** * The `LambdaConflictHandlerConfig` when configuring `LAMBDA` as the Conflict Handler. + * + * @var LambdaConflictHandlerConfig|null */ private $lambdaConflictHandlerConfig; diff --git a/src/Service/Athena/src/Exception/InvalidRequestException.php b/src/Service/Athena/src/Exception/InvalidRequestException.php index c09e92578..72ccad20d 100644 --- a/src/Service/Athena/src/Exception/InvalidRequestException.php +++ b/src/Service/Athena/src/Exception/InvalidRequestException.php @@ -11,6 +11,9 @@ */ final class InvalidRequestException extends ClientException { + /** + * @var string|null + */ private $athenaErrorCode; public function getAthenaErrorCode(): ?string diff --git a/src/Service/Athena/src/Exception/ResourceNotFoundException.php b/src/Service/Athena/src/Exception/ResourceNotFoundException.php index a5e8ecc58..4d3c2f380 100644 --- a/src/Service/Athena/src/Exception/ResourceNotFoundException.php +++ b/src/Service/Athena/src/Exception/ResourceNotFoundException.php @@ -12,6 +12,8 @@ final class ResourceNotFoundException extends ClientException { /** * The name of the Amazon resource. + * + * @var string|null */ private $resourceName; diff --git a/src/Service/Athena/src/Exception/TooManyRequestsException.php b/src/Service/Athena/src/Exception/TooManyRequestsException.php index b74a5d284..5a42b4737 100644 --- a/src/Service/Athena/src/Exception/TooManyRequestsException.php +++ b/src/Service/Athena/src/Exception/TooManyRequestsException.php @@ -11,6 +11,9 @@ */ final class TooManyRequestsException extends ClientException { + /** + * @var ThrottleReason::*|null + */ private $reason; /** diff --git a/src/Service/Athena/src/Result/GetCalculationExecutionResponse.php b/src/Service/Athena/src/Result/GetCalculationExecutionResponse.php index 8ac4f7445..bcd5faf28 100644 --- a/src/Service/Athena/src/Result/GetCalculationExecutionResponse.php +++ b/src/Service/Athena/src/Result/GetCalculationExecutionResponse.php @@ -12,37 +12,51 @@ class GetCalculationExecutionResponse extends Result { /** * The calculation execution UUID. + * + * @var string|null */ private $calculationExecutionId; /** * The session ID that the calculation ran in. + * + * @var string|null */ private $sessionId; /** * The description of the calculation execution. + * + * @var string|null */ private $description; /** * The Amazon S3 location in which calculation results are stored. + * + * @var string|null */ private $workingDirectory; /** * Contains information about the status of the calculation. + * + * @var CalculationStatus|null */ private $status; /** * Contains information about the data processing unit (DPU) execution time and progress. This field is populated only * when statistics are available. + * + * @var CalculationStatistics|null */ private $statistics; /** * Contains result information. This field is populated only if the calculation is completed. + * + * @var CalculationResult|null */ private $result; diff --git a/src/Service/Athena/src/Result/GetCalculationExecutionStatusResponse.php b/src/Service/Athena/src/Result/GetCalculationExecutionStatusResponse.php index a79dd3601..cc15e5781 100644 --- a/src/Service/Athena/src/Result/GetCalculationExecutionStatusResponse.php +++ b/src/Service/Athena/src/Result/GetCalculationExecutionStatusResponse.php @@ -11,11 +11,15 @@ class GetCalculationExecutionStatusResponse extends Result { /** * Contains information about the calculation execution status. + * + * @var CalculationStatus|null */ private $status; /** * Contains information about the DPU execution time and progress. + * + * @var CalculationStatistics|null */ private $statistics; diff --git a/src/Service/Athena/src/Result/GetDataCatalogOutput.php b/src/Service/Athena/src/Result/GetDataCatalogOutput.php index 771dc34c1..364a390d4 100644 --- a/src/Service/Athena/src/Result/GetDataCatalogOutput.php +++ b/src/Service/Athena/src/Result/GetDataCatalogOutput.php @@ -10,6 +10,8 @@ class GetDataCatalogOutput extends Result { /** * The data catalog returned. + * + * @var DataCatalog|null */ private $dataCatalog; diff --git a/src/Service/Athena/src/Result/GetDatabaseOutput.php b/src/Service/Athena/src/Result/GetDatabaseOutput.php index 5b9287a16..85a3456c5 100644 --- a/src/Service/Athena/src/Result/GetDatabaseOutput.php +++ b/src/Service/Athena/src/Result/GetDatabaseOutput.php @@ -10,6 +10,8 @@ class GetDatabaseOutput extends Result { /** * The database returned. + * + * @var Database|null */ private $database; diff --git a/src/Service/Athena/src/Result/GetNamedQueryOutput.php b/src/Service/Athena/src/Result/GetNamedQueryOutput.php index f8bf3e764..9f69ff7a5 100644 --- a/src/Service/Athena/src/Result/GetNamedQueryOutput.php +++ b/src/Service/Athena/src/Result/GetNamedQueryOutput.php @@ -10,6 +10,8 @@ class GetNamedQueryOutput extends Result { /** * Information about the query. + * + * @var NamedQuery|null */ private $namedQuery; diff --git a/src/Service/Athena/src/Result/GetQueryExecutionOutput.php b/src/Service/Athena/src/Result/GetQueryExecutionOutput.php index 0bcd278c7..9187e38d0 100644 --- a/src/Service/Athena/src/Result/GetQueryExecutionOutput.php +++ b/src/Service/Athena/src/Result/GetQueryExecutionOutput.php @@ -21,6 +21,8 @@ class GetQueryExecutionOutput extends Result { /** * Information about the query execution. + * + * @var QueryExecution|null */ private $queryExecution; diff --git a/src/Service/Athena/src/Result/GetQueryResultsOutput.php b/src/Service/Athena/src/Result/GetQueryResultsOutput.php index 81357a448..e24c99ce9 100644 --- a/src/Service/Athena/src/Result/GetQueryResultsOutput.php +++ b/src/Service/Athena/src/Result/GetQueryResultsOutput.php @@ -20,11 +20,15 @@ class GetQueryResultsOutput extends Result implements \IteratorAggregate { /** * The number of rows inserted with a `CREATE TABLE AS SELECT` statement. + * + * @var int|null */ private $updateCount; /** * The results of the query execution. + * + * @var ResultSet|null */ private $resultSet; @@ -32,6 +36,8 @@ class GetQueryResultsOutput extends Result implements \IteratorAggregate * A token generated by the Athena service that specifies where to continue pagination if a previous request was * truncated. To obtain the next set of pages, pass in the `NextToken` from the response object of the previous page * call. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Athena/src/Result/GetSessionResponse.php b/src/Service/Athena/src/Result/GetSessionResponse.php index 3c47c819b..6b232448f 100644 --- a/src/Service/Athena/src/Result/GetSessionResponse.php +++ b/src/Service/Athena/src/Result/GetSessionResponse.php @@ -14,47 +14,65 @@ class GetSessionResponse extends Result { /** * The session ID. + * + * @var string|null */ private $sessionId; /** * The session description. + * + * @var string|null */ private $description; /** * The workgroup to which the session belongs. + * + * @var string|null */ private $workGroup; /** * The engine version used by the session (for example, `PySpark engine version 3`). You can get a list of engine * versions by calling ListEngineVersions. + * + * @var string|null */ private $engineVersion; /** * Contains engine configuration information like DPU usage. + * + * @var EngineConfiguration|null */ private $engineConfiguration; /** * The notebook version. + * + * @var string|null */ private $notebookVersion; /** * Contains the workgroup configuration information used by the session. + * + * @var SessionConfiguration|null */ private $sessionConfiguration; /** * Contains information about the status of the session. + * + * @var SessionStatus|null */ private $status; /** * Contains the DPU execution time. + * + * @var SessionStatistics|null */ private $statistics; diff --git a/src/Service/Athena/src/Result/GetSessionStatusResponse.php b/src/Service/Athena/src/Result/GetSessionStatusResponse.php index b127b8c4c..92a7fea0a 100644 --- a/src/Service/Athena/src/Result/GetSessionStatusResponse.php +++ b/src/Service/Athena/src/Result/GetSessionStatusResponse.php @@ -10,11 +10,15 @@ class GetSessionStatusResponse extends Result { /** * The session ID. + * + * @var string|null */ private $sessionId; /** * Contains information about the status of the session. + * + * @var SessionStatus|null */ private $status; diff --git a/src/Service/Athena/src/Result/GetTableMetadataOutput.php b/src/Service/Athena/src/Result/GetTableMetadataOutput.php index 74ca4f7cb..47ce54908 100644 --- a/src/Service/Athena/src/Result/GetTableMetadataOutput.php +++ b/src/Service/Athena/src/Result/GetTableMetadataOutput.php @@ -11,6 +11,8 @@ class GetTableMetadataOutput extends Result { /** * An object that contains table metadata. + * + * @var TableMetadata|null */ private $tableMetadata; diff --git a/src/Service/Athena/src/Result/GetWorkGroupOutput.php b/src/Service/Athena/src/Result/GetWorkGroupOutput.php index dfe94c938..d86cfab66 100644 --- a/src/Service/Athena/src/Result/GetWorkGroupOutput.php +++ b/src/Service/Athena/src/Result/GetWorkGroupOutput.php @@ -16,6 +16,8 @@ class GetWorkGroupOutput extends Result { /** * Information about the workgroup. + * + * @var WorkGroup|null */ private $workGroup; diff --git a/src/Service/Athena/src/Result/ListDatabasesOutput.php b/src/Service/Athena/src/Result/ListDatabasesOutput.php index 0140e017f..2a1c28c20 100644 --- a/src/Service/Athena/src/Result/ListDatabasesOutput.php +++ b/src/Service/Athena/src/Result/ListDatabasesOutput.php @@ -16,12 +16,16 @@ class ListDatabasesOutput extends Result implements \IteratorAggregate { /** * A list of databases from a data catalog. + * + * @var Database[] */ private $databaseList; /** * A token generated by the Athena service that specifies where to continue pagination if a previous request was * truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Athena/src/Result/ListNamedQueriesOutput.php b/src/Service/Athena/src/Result/ListNamedQueriesOutput.php index 9d023c9d0..aac92489a 100644 --- a/src/Service/Athena/src/Result/ListNamedQueriesOutput.php +++ b/src/Service/Athena/src/Result/ListNamedQueriesOutput.php @@ -15,6 +15,8 @@ class ListNamedQueriesOutput extends Result implements \IteratorAggregate { /** * The list of unique query IDs. + * + * @var string[] */ private $namedQueryIds; @@ -22,6 +24,8 @@ class ListNamedQueriesOutput extends Result implements \IteratorAggregate * A token generated by the Athena service that specifies where to continue pagination if a previous request was * truncated. To obtain the next set of pages, pass in the `NextToken` from the response object of the previous page * call. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Athena/src/Result/ListQueryExecutionsOutput.php b/src/Service/Athena/src/Result/ListQueryExecutionsOutput.php index db453999b..09cbb1fbc 100644 --- a/src/Service/Athena/src/Result/ListQueryExecutionsOutput.php +++ b/src/Service/Athena/src/Result/ListQueryExecutionsOutput.php @@ -15,11 +15,15 @@ class ListQueryExecutionsOutput extends Result implements \IteratorAggregate { /** * The unique IDs of each query execution as an array of strings. + * + * @var string[] */ private $queryExecutionIds; /** * A token to be used by the next request if this request is truncated. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Athena/src/Result/ListTableMetadataOutput.php b/src/Service/Athena/src/Result/ListTableMetadataOutput.php index f3a2e69b6..64c1860a5 100644 --- a/src/Service/Athena/src/Result/ListTableMetadataOutput.php +++ b/src/Service/Athena/src/Result/ListTableMetadataOutput.php @@ -17,12 +17,16 @@ class ListTableMetadataOutput extends Result implements \IteratorAggregate { /** * A list of table metadata. + * + * @var TableMetadata[] */ private $tableMetadataList; /** * A token generated by the Athena service that specifies where to continue pagination if a previous request was * truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Athena/src/Result/StartCalculationExecutionResponse.php b/src/Service/Athena/src/Result/StartCalculationExecutionResponse.php index 9391128d4..baf9ca56c 100644 --- a/src/Service/Athena/src/Result/StartCalculationExecutionResponse.php +++ b/src/Service/Athena/src/Result/StartCalculationExecutionResponse.php @@ -10,6 +10,8 @@ class StartCalculationExecutionResponse extends Result { /** * The calculation execution UUID. + * + * @var string|null */ private $calculationExecutionId; @@ -29,6 +31,8 @@ class StartCalculationExecutionResponse extends Result * `COMPLETED` - The calculation has completed without error. * * `FAILED` - The calculation failed and is no longer running. + * + * @var CalculationExecutionState::*|null */ private $state; diff --git a/src/Service/Athena/src/Result/StartQueryExecutionOutput.php b/src/Service/Athena/src/Result/StartQueryExecutionOutput.php index 0d459c979..419937341 100644 --- a/src/Service/Athena/src/Result/StartQueryExecutionOutput.php +++ b/src/Service/Athena/src/Result/StartQueryExecutionOutput.php @@ -9,6 +9,8 @@ class StartQueryExecutionOutput extends Result { /** * The unique ID of the query that ran as a result of this request. + * + * @var string|null */ private $queryExecutionId; diff --git a/src/Service/Athena/src/Result/StartSessionResponse.php b/src/Service/Athena/src/Result/StartSessionResponse.php index ef6fcd389..489a7297d 100644 --- a/src/Service/Athena/src/Result/StartSessionResponse.php +++ b/src/Service/Athena/src/Result/StartSessionResponse.php @@ -10,6 +10,8 @@ class StartSessionResponse extends Result { /** * The session ID. + * + * @var string|null */ private $sessionId; @@ -31,6 +33,8 @@ class StartSessionResponse extends Result * `DEGRADED` - The session has no healthy coordinators. * * `FAILED` - Due to a failure, the session and its resources are no longer running. + * + * @var SessionState::*|null */ private $state; diff --git a/src/Service/Athena/src/Result/StopCalculationExecutionResponse.php b/src/Service/Athena/src/Result/StopCalculationExecutionResponse.php index ea8c5d032..99cc74092 100644 --- a/src/Service/Athena/src/Result/StopCalculationExecutionResponse.php +++ b/src/Service/Athena/src/Result/StopCalculationExecutionResponse.php @@ -24,6 +24,8 @@ class StopCalculationExecutionResponse extends Result * `COMPLETED` - The calculation has completed without error. * * `FAILED` - The calculation failed and is no longer running. + * + * @var CalculationExecutionState::*|null */ private $state; diff --git a/src/Service/Athena/src/Result/TerminateSessionResponse.php b/src/Service/Athena/src/Result/TerminateSessionResponse.php index 4126b441a..d773572d2 100644 --- a/src/Service/Athena/src/Result/TerminateSessionResponse.php +++ b/src/Service/Athena/src/Result/TerminateSessionResponse.php @@ -26,6 +26,8 @@ class TerminateSessionResponse extends Result * `DEGRADED` - The session has no healthy coordinators. * * `FAILED` - Due to a failure, the session and its resources are no longer running. + * + * @var SessionState::*|null */ private $state; diff --git a/src/Service/Athena/src/ValueObject/AclConfiguration.php b/src/Service/Athena/src/ValueObject/AclConfiguration.php index 5b3e385bb..40f552223 100644 --- a/src/Service/Athena/src/ValueObject/AclConfiguration.php +++ b/src/Service/Athena/src/ValueObject/AclConfiguration.php @@ -21,6 +21,8 @@ final class AclConfiguration * workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl + * + * @var S3AclOption::* */ private $s3AclOption; diff --git a/src/Service/Athena/src/ValueObject/AthenaError.php b/src/Service/Athena/src/ValueObject/AthenaError.php index 6a6cb5406..a80c7e417 100644 --- a/src/Service/Athena/src/ValueObject/AthenaError.php +++ b/src/Service/Athena/src/ValueObject/AthenaError.php @@ -19,6 +19,8 @@ final class AthenaError * **2** - User * * **3** - Other + * + * @var int|null */ private $errorCategory; @@ -27,16 +29,22 @@ final class AthenaError * see the Error Type Reference [^1] in the *Amazon Athena User Guide*. * * [^1]: https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference + * + * @var int|null */ private $errorType; /** * True if the query might succeed if resubmitted. + * + * @var bool|null */ private $retryable; /** * Contains a short description of the error that occurred. + * + * @var string|null */ private $errorMessage; diff --git a/src/Service/Athena/src/ValueObject/CalculationConfiguration.php b/src/Service/Athena/src/ValueObject/CalculationConfiguration.php index 721997b07..f0b8e2f47 100644 --- a/src/Service/Athena/src/ValueObject/CalculationConfiguration.php +++ b/src/Service/Athena/src/ValueObject/CalculationConfiguration.php @@ -9,6 +9,8 @@ final class CalculationConfiguration { /** * A string that contains the code for the calculation. + * + * @var string|null */ private $codeBlock; diff --git a/src/Service/Athena/src/ValueObject/CalculationResult.php b/src/Service/Athena/src/ValueObject/CalculationResult.php index aa9585c79..3e2b058c0 100644 --- a/src/Service/Athena/src/ValueObject/CalculationResult.php +++ b/src/Service/Athena/src/ValueObject/CalculationResult.php @@ -9,21 +9,29 @@ final class CalculationResult { /** * The Amazon S3 location of the `stdout` file for the calculation. + * + * @var string|null */ private $stdOutS3Uri; /** * The Amazon S3 location of the `stderr` error messages file for the calculation. + * + * @var string|null */ private $stdErrorS3Uri; /** * The Amazon S3 location of the folder for the calculation results. + * + * @var string|null */ private $resultS3Uri; /** * The data format of the calculation result. + * + * @var string|null */ private $resultType; diff --git a/src/Service/Athena/src/ValueObject/CalculationStatistics.php b/src/Service/Athena/src/ValueObject/CalculationStatistics.php index aa73185db..1b09606b4 100644 --- a/src/Service/Athena/src/ValueObject/CalculationStatistics.php +++ b/src/Service/Athena/src/ValueObject/CalculationStatistics.php @@ -9,11 +9,15 @@ final class CalculationStatistics { /** * The data processing unit execution time in milliseconds for the calculation. + * + * @var int|null */ private $dpuExecutionInMillis; /** * The progress of the calculation. + * + * @var string|null */ private $progress; diff --git a/src/Service/Athena/src/ValueObject/CalculationStatus.php b/src/Service/Athena/src/ValueObject/CalculationStatus.php index 151b4d517..348b4cb32 100644 --- a/src/Service/Athena/src/ValueObject/CalculationStatus.php +++ b/src/Service/Athena/src/ValueObject/CalculationStatus.php @@ -11,11 +11,15 @@ final class CalculationStatus { /** * The date and time the calculation was submitted for processing. + * + * @var \DateTimeImmutable|null */ private $submissionDateTime; /** * The date and time the calculation completed processing. + * + * @var \DateTimeImmutable|null */ private $completionDateTime; @@ -37,12 +41,16 @@ final class CalculationStatus * `COMPLETED` - The calculation has completed without error. * * `FAILED` - The calculation failed and is no longer running. + * + * @var CalculationExecutionState::*|null */ private $state; /** * The reason for the calculation state change (for example, the calculation was canceled because the session was * terminated). + * + * @var string|null */ private $stateChangeReason; diff --git a/src/Service/Athena/src/ValueObject/Column.php b/src/Service/Athena/src/ValueObject/Column.php index 7914585b2..ff3950795 100644 --- a/src/Service/Athena/src/ValueObject/Column.php +++ b/src/Service/Athena/src/ValueObject/Column.php @@ -11,16 +11,22 @@ final class Column { /** * The name of the column. + * + * @var string */ private $name; /** * The data type of the column. + * + * @var string|null */ private $type; /** * Optional information about the column. + * + * @var string|null */ private $comment; diff --git a/src/Service/Athena/src/ValueObject/ColumnInfo.php b/src/Service/Athena/src/ValueObject/ColumnInfo.php index b02e39914..f2eba4f8c 100644 --- a/src/Service/Athena/src/ValueObject/ColumnInfo.php +++ b/src/Service/Athena/src/ValueObject/ColumnInfo.php @@ -12,52 +12,72 @@ final class ColumnInfo { /** * The catalog to which the query results belong. + * + * @var string|null */ private $catalogName; /** * The schema name (database name) to which the query results belong. + * + * @var string|null */ private $schemaName; /** * The table name for the query results. + * + * @var string|null */ private $tableName; /** * The name of the column. + * + * @var string */ private $name; /** * A column label. + * + * @var string|null */ private $label; /** * The data type of the column. + * + * @var string */ private $type; /** * For `DECIMAL` data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to * 18 digits. + * + * @var int|null */ private $precision; /** * For `DECIMAL` data types, specifies the total number of digits in the fractional part of the value. Defaults to 0. + * + * @var int|null */ private $scale; /** * Indicates the column's nullable status. + * + * @var ColumnNullable::*|null */ private $nullable; /** * Indicates whether values in the column are case-sensitive. + * + * @var bool|null */ private $caseSensitive; diff --git a/src/Service/Athena/src/ValueObject/CustomerContentEncryptionConfiguration.php b/src/Service/Athena/src/ValueObject/CustomerContentEncryptionConfiguration.php index 804fc9840..2bcb05b48 100644 --- a/src/Service/Athena/src/ValueObject/CustomerContentEncryptionConfiguration.php +++ b/src/Service/Athena/src/ValueObject/CustomerContentEncryptionConfiguration.php @@ -12,6 +12,8 @@ final class CustomerContentEncryptionConfiguration { /** * The KMS key that is used to encrypt the user's data stores in Athena. + * + * @var string */ private $kmsKey; diff --git a/src/Service/Athena/src/ValueObject/DataCatalog.php b/src/Service/Athena/src/ValueObject/DataCatalog.php index dfdce9319..d52df488e 100644 --- a/src/Service/Athena/src/ValueObject/DataCatalog.php +++ b/src/Service/Athena/src/ValueObject/DataCatalog.php @@ -17,17 +17,23 @@ final class DataCatalog * The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a * maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 * is reserved for use by Athena. + * + * @var string */ private $name; /** * An optional description of the data catalog. + * + * @var string|null */ private $description; /** * The type of data catalog to create: `LAMBDA` for a federated catalog, `HIVE` for an external hive metastore, or * `GLUE` for an Glue Data Catalog. + * + * @var DataCatalogType::* */ private $type; @@ -59,6 +65,8 @@ final class DataCatalog * which you can have only one and cannot modify. * - Queries that specify a Glue Data Catalog other than the default `AwsDataCatalog` must be run on Athena engine * version 2. + * + * @var array|null */ private $parameters; diff --git a/src/Service/Athena/src/ValueObject/Database.php b/src/Service/Athena/src/ValueObject/Database.php index b6835a527..bca941c3d 100644 --- a/src/Service/Athena/src/ValueObject/Database.php +++ b/src/Service/Athena/src/ValueObject/Database.php @@ -11,16 +11,22 @@ final class Database { /** * The name of the database. + * + * @var string */ private $name; /** * An optional description of the database. + * + * @var string|null */ private $description; /** * A set of custom key/value pairs. + * + * @var array|null */ private $parameters; diff --git a/src/Service/Athena/src/ValueObject/Datum.php b/src/Service/Athena/src/ValueObject/Datum.php index 41873d03c..e0c0658a7 100644 --- a/src/Service/Athena/src/ValueObject/Datum.php +++ b/src/Service/Athena/src/ValueObject/Datum.php @@ -9,6 +9,8 @@ final class Datum { /** * The value of the datum. + * + * @var string|null */ private $varCharValue; diff --git a/src/Service/Athena/src/ValueObject/EncryptionConfiguration.php b/src/Service/Athena/src/ValueObject/EncryptionConfiguration.php index da56cd0d3..b69c07452 100644 --- a/src/Service/Athena/src/ValueObject/EncryptionConfiguration.php +++ b/src/Service/Athena/src/ValueObject/EncryptionConfiguration.php @@ -17,11 +17,15 @@ final class EncryptionConfiguration * * If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for * encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. + * + * @var EncryptionOption::* */ private $encryptionOption; /** * For `SSE_KMS` and `CSE_KMS`, this is the KMS key ARN or ID. + * + * @var string|null */ private $kmsKey; diff --git a/src/Service/Athena/src/ValueObject/EngineConfiguration.php b/src/Service/Athena/src/ValueObject/EngineConfiguration.php index 8debe4182..b87aab708 100644 --- a/src/Service/Athena/src/ValueObject/EngineConfiguration.php +++ b/src/Service/Athena/src/ValueObject/EngineConfiguration.php @@ -12,17 +12,23 @@ final class EngineConfiguration /** * The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work * and manages other executors in a notebook session. The default is 1. + * + * @var int|null */ private $coordinatorDpuSize; /** * The maximum number of DPUs that can run concurrently. + * + * @var int */ private $maxConcurrentDpus; /** * The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session * can request from Athena. The default is 1. + * + * @var int|null */ private $defaultExecutorDpuSize; @@ -31,12 +37,16 @@ final class EngineConfiguration * specify an Athena notebook that the Jupyter server will download and serve, specify a value for the * StartSessionRequest$NotebookVersion field, and then add a key named `NotebookId` to `AdditionalConfigs` that has the * value of the Athena notebook ID. + * + * @var array|null */ private $additionalConfigs; /** * Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general * Spark tuning. + * + * @var array|null */ private $sparkProperties; diff --git a/src/Service/Athena/src/ValueObject/EngineVersion.php b/src/Service/Athena/src/ValueObject/EngineVersion.php index 8d0d08cf6..98e97cfbd 100644 --- a/src/Service/Athena/src/ValueObject/EngineVersion.php +++ b/src/Service/Athena/src/ValueObject/EngineVersion.php @@ -10,6 +10,8 @@ final class EngineVersion /** * The engine version requested by the user. Possible values are determined by the output of `ListEngineVersions`, * including AUTO. The default is AUTO. + * + * @var string|null */ private $selectedEngineVersion; @@ -18,6 +20,8 @@ final class EngineVersion * the effective engine version is the same as the engine version that the user requested. If the user requests Auto, * the effective engine version is chosen by Athena. When a request to update the engine version is made by a * `CreateWorkGroup` or `UpdateWorkGroup` operation, the `EffectiveEngineVersion` field is ignored. + * + * @var string|null */ private $effectiveEngineVersion; diff --git a/src/Service/Athena/src/ValueObject/NamedQuery.php b/src/Service/Athena/src/ValueObject/NamedQuery.php index ab14dabc7..a9db19c71 100644 --- a/src/Service/Athena/src/ValueObject/NamedQuery.php +++ b/src/Service/Athena/src/ValueObject/NamedQuery.php @@ -11,31 +11,43 @@ final class NamedQuery { /** * The query name. + * + * @var string */ private $name; /** * The query description. + * + * @var string|null */ private $description; /** * The database to which the query belongs. + * + * @var string */ private $database; /** * The SQL statements that make up the query. + * + * @var string */ private $queryString; /** * The unique identifier of the query. + * + * @var string|null */ private $namedQueryId; /** * The name of the workgroup that contains the named query. + * + * @var string|null */ private $workGroup; diff --git a/src/Service/Athena/src/ValueObject/QueryExecution.php b/src/Service/Athena/src/ValueObject/QueryExecution.php index e7a191039..3e05e06db 100644 --- a/src/Service/Athena/src/ValueObject/QueryExecution.php +++ b/src/Service/Athena/src/ValueObject/QueryExecution.php @@ -11,11 +11,15 @@ final class QueryExecution { /** * The unique identifier for each query execution. + * + * @var string|null */ private $queryExecutionId; /** * The SQL query statements which the query execution ran. + * + * @var string|null */ private $query; @@ -23,6 +27,8 @@ final class QueryExecution * The type of query statement that was run. `DDL` indicates DDL query statements. `DML` indicates DML (Data * Manipulation Language) query statements, such as `CREATE TABLE AS SELECT`. `UTILITY` indicates query statements other * than DDL and DML, such as `SHOW CREATE TABLE`, or `DESCRIBE TABLE`. + * + * @var StatementType::*|null */ private $statementType; @@ -31,48 +37,66 @@ final class QueryExecution * query results. These are known as "client-side settings". If workgroup settings override client-side settings, then * the query uses the location for the query results and the encryption configuration that are specified for the * workgroup. + * + * @var ResultConfiguration|null */ private $resultConfiguration; /** * Specifies the query result reuse behavior that was used for the query. + * + * @var ResultReuseConfiguration|null */ private $resultReuseConfiguration; /** * The database in which the query execution occurred. + * + * @var QueryExecutionContext|null */ private $queryExecutionContext; /** * The completion date, current state, submission time, and state change reason (if applicable) for the query execution. + * + * @var QueryExecutionStatus|null */ private $status; /** * Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, * and the type of statement that was run. + * + * @var QueryExecutionStatistics|null */ private $statistics; /** * The name of the workgroup in which the query ran. + * + * @var string|null */ private $workGroup; /** * The engine version that executed the query. + * + * @var EngineVersion|null */ private $engineVersion; /** * A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in * the order in which the parameters occur. The list of parameters is not returned in the response. + * + * @var string[]|null */ private $executionParameters; /** * The kind of query statement that was run. + * + * @var string|null */ private $substatementType; diff --git a/src/Service/Athena/src/ValueObject/QueryExecutionContext.php b/src/Service/Athena/src/ValueObject/QueryExecutionContext.php index 582af949b..0f2af2fd2 100644 --- a/src/Service/Athena/src/ValueObject/QueryExecutionContext.php +++ b/src/Service/Athena/src/ValueObject/QueryExecutionContext.php @@ -9,11 +9,15 @@ final class QueryExecutionContext { /** * The name of the database used in the query execution. The database must exist in the catalog. + * + * @var string|null */ private $database; /** * The name of the data catalog used in the query execution. + * + * @var string|null */ private $catalog; diff --git a/src/Service/Athena/src/ValueObject/QueryExecutionStatistics.php b/src/Service/Athena/src/ValueObject/QueryExecutionStatistics.php index 3485073e0..31d592dc5 100644 --- a/src/Service/Athena/src/ValueObject/QueryExecutionStatistics.php +++ b/src/Service/Athena/src/ValueObject/QueryExecutionStatistics.php @@ -10,11 +10,15 @@ final class QueryExecutionStatistics { /** * The number of milliseconds that the query took to execute. + * + * @var int|null */ private $engineExecutionTimeInMillis; /** * The number of bytes in the data that was queried. + * + * @var int|null */ private $dataScannedInBytes; @@ -26,17 +30,23 @@ final class QueryExecutionStatistics * the *Amazon Athena User Guide*. * * [^1]: https://docs.aws.amazon.com/athena/latest/ug/querying.html + * + * @var string|null */ private $dataManifestLocation; /** * The number of milliseconds that Athena took to run the query. + * + * @var int|null */ private $totalExecutionTimeInMillis; /** * The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient * errors occur, Athena might automatically add the query back to the queue. + * + * @var int|null */ private $queryQueueTimeInMillis; @@ -44,17 +54,23 @@ final class QueryExecutionStatistics * The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent * retrieving table partitions from the data source. Note that because the query engine performs the query planning, * query planning time is a subset of engine processing time. + * + * @var int|null */ private $queryPlanningTimeInMillis; /** * The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished * running the query. + * + * @var int|null */ private $serviceProcessingTimeInMillis; /** * Contains information about whether previous query results were reused for the query. + * + * @var ResultReuseInformation|null */ private $resultReuseInformation; diff --git a/src/Service/Athena/src/ValueObject/QueryExecutionStatus.php b/src/Service/Athena/src/ValueObject/QueryExecutionStatus.php index 6908016e4..0b7f519aa 100644 --- a/src/Service/Athena/src/ValueObject/QueryExecutionStatus.php +++ b/src/Service/Athena/src/ValueObject/QueryExecutionStatus.php @@ -17,26 +17,36 @@ final class QueryExecutionStatus * * > Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query * > state transition from `RUNNING` or `FAILED` to `QUEUED`. + * + * @var QueryExecutionState::*|null */ private $state; /** * Further detail about the status of the query. + * + * @var string|null */ private $stateChangeReason; /** * The date and time that the query was submitted. + * + * @var \DateTimeImmutable|null */ private $submissionDateTime; /** * The date and time that the query completed. + * + * @var \DateTimeImmutable|null */ private $completionDateTime; /** * Provides information about an Athena query error. + * + * @var AthenaError|null */ private $athenaError; diff --git a/src/Service/Athena/src/ValueObject/ResultConfiguration.php b/src/Service/Athena/src/ValueObject/ResultConfiguration.php index f47d38e12..5b83e9866 100644 --- a/src/Service/Athena/src/ValueObject/ResultConfiguration.php +++ b/src/Service/Athena/src/ValueObject/ResultConfiguration.php @@ -18,6 +18,8 @@ final class ResultConfiguration * settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. * * [^1]: https://docs.aws.amazon.com/athena/latest/ug/querying.html + * + * @var string|null */ private $outputLocation; @@ -29,6 +31,8 @@ final class ResultConfiguration * WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings [^1]. * * [^1]: https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html + * + * @var EncryptionConfiguration|null */ private $encryptionConfiguration; @@ -44,6 +48,8 @@ final class ResultConfiguration * Override Client-Side Settings [^1]. * * [^1]: https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html + * + * @var string|null */ private $expectedBucketOwner; @@ -55,6 +61,8 @@ final class ResultConfiguration * WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings [^1]. * * [^1]: https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html + * + * @var AclConfiguration|null */ private $aclConfiguration; diff --git a/src/Service/Athena/src/ValueObject/ResultReuseByAgeConfiguration.php b/src/Service/Athena/src/ValueObject/ResultReuseByAgeConfiguration.php index b966260d6..2af0903bc 100644 --- a/src/Service/Athena/src/ValueObject/ResultReuseByAgeConfiguration.php +++ b/src/Service/Athena/src/ValueObject/ResultReuseByAgeConfiguration.php @@ -11,12 +11,16 @@ final class ResultReuseByAgeConfiguration { /** * True if previous query results can be reused when the query is run; otherwise, false. The default is false. + * + * @var bool */ private $enabled; /** * Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. The default * is 60. + * + * @var int|null */ private $maxAgeInMinutes; diff --git a/src/Service/Athena/src/ValueObject/ResultReuseConfiguration.php b/src/Service/Athena/src/ValueObject/ResultReuseConfiguration.php index 24c220e9f..e0a9b558c 100644 --- a/src/Service/Athena/src/ValueObject/ResultReuseConfiguration.php +++ b/src/Service/Athena/src/ValueObject/ResultReuseConfiguration.php @@ -9,6 +9,8 @@ final class ResultReuseConfiguration { /** * Specifies whether previous query results are reused, and if so, their maximum age. + * + * @var ResultReuseByAgeConfiguration|null */ private $resultReuseByAgeConfiguration; diff --git a/src/Service/Athena/src/ValueObject/ResultReuseInformation.php b/src/Service/Athena/src/ValueObject/ResultReuseInformation.php index 989272bd3..baefa4331 100644 --- a/src/Service/Athena/src/ValueObject/ResultReuseInformation.php +++ b/src/Service/Athena/src/ValueObject/ResultReuseInformation.php @@ -11,6 +11,8 @@ final class ResultReuseInformation { /** * True if a previous query result was reused; false if the result was generated from a new run of the query. + * + * @var bool */ private $reusedPreviousResult; diff --git a/src/Service/Athena/src/ValueObject/ResultSet.php b/src/Service/Athena/src/ValueObject/ResultSet.php index 751a2bab0..19df9d9a4 100644 --- a/src/Service/Athena/src/ValueObject/ResultSet.php +++ b/src/Service/Athena/src/ValueObject/ResultSet.php @@ -10,11 +10,15 @@ final class ResultSet { /** * The rows in the table. + * + * @var Row[]|null */ private $rows; /** * The metadata that describes the column structure and data types of a table of query results. + * + * @var ResultSetMetadata|null */ private $resultSetMetadata; diff --git a/src/Service/Athena/src/ValueObject/ResultSetMetadata.php b/src/Service/Athena/src/ValueObject/ResultSetMetadata.php index 5a3f6155a..1292f941b 100644 --- a/src/Service/Athena/src/ValueObject/ResultSetMetadata.php +++ b/src/Service/Athena/src/ValueObject/ResultSetMetadata.php @@ -10,6 +10,8 @@ final class ResultSetMetadata { /** * Information about the columns returned in a query result metadata. + * + * @var ColumnInfo[]|null */ private $columnInfo; diff --git a/src/Service/Athena/src/ValueObject/Row.php b/src/Service/Athena/src/ValueObject/Row.php index fa1d92de8..c11e9f87c 100644 --- a/src/Service/Athena/src/ValueObject/Row.php +++ b/src/Service/Athena/src/ValueObject/Row.php @@ -9,6 +9,8 @@ final class Row { /** * The data that populates a row in a query result table. + * + * @var Datum[]|null */ private $data; diff --git a/src/Service/Athena/src/ValueObject/SessionConfiguration.php b/src/Service/Athena/src/ValueObject/SessionConfiguration.php index 088d332e3..12727662f 100644 --- a/src/Service/Athena/src/ValueObject/SessionConfiguration.php +++ b/src/Service/Athena/src/ValueObject/SessionConfiguration.php @@ -9,19 +9,28 @@ final class SessionConfiguration { /** * The ARN of the execution role used for the session. + * + * @var string|null */ private $executionRole; /** * The Amazon S3 location that stores information for the notebook. + * + * @var string|null */ private $workingDirectory; /** * The idle timeout in seconds for the session. + * + * @var int|null */ private $idleTimeoutSeconds; + /** + * @var EncryptionConfiguration|null + */ private $encryptionConfiguration; /** diff --git a/src/Service/Athena/src/ValueObject/SessionStatistics.php b/src/Service/Athena/src/ValueObject/SessionStatistics.php index bb24ea57d..c88f5130a 100644 --- a/src/Service/Athena/src/ValueObject/SessionStatistics.php +++ b/src/Service/Athena/src/ValueObject/SessionStatistics.php @@ -9,6 +9,8 @@ final class SessionStatistics { /** * The data processing unit execution time for a session in milliseconds. + * + * @var int|null */ private $dpuExecutionInMillis; diff --git a/src/Service/Athena/src/ValueObject/SessionStatus.php b/src/Service/Athena/src/ValueObject/SessionStatus.php index 2af87d7e8..0db1ab26e 100644 --- a/src/Service/Athena/src/ValueObject/SessionStatus.php +++ b/src/Service/Athena/src/ValueObject/SessionStatus.php @@ -11,21 +11,29 @@ final class SessionStatus { /** * The date and time that the session started. + * + * @var \DateTimeImmutable|null */ private $startDateTime; /** * The most recent date and time that the session was modified. + * + * @var \DateTimeImmutable|null */ private $lastModifiedDateTime; /** * The date and time that the session ended. + * + * @var \DateTimeImmutable|null */ private $endDateTime; /** * The date and time starting at which the session became idle. Can be empty if the session is not currently idle. + * + * @var \DateTimeImmutable|null */ private $idleSinceDateTime; @@ -47,11 +55,15 @@ final class SessionStatus * `DEGRADED` - The session has no healthy coordinators. * * `FAILED` - Due to a failure, the session and its resources are no longer running. + * + * @var SessionState::*|null */ private $state; /** * The reason for the session state change (for example, canceled because the session was terminated). + * + * @var string|null */ private $stateChangeReason; diff --git a/src/Service/Athena/src/ValueObject/TableMetadata.php b/src/Service/Athena/src/ValueObject/TableMetadata.php index bc2c9194a..c1d246db8 100644 --- a/src/Service/Athena/src/ValueObject/TableMetadata.php +++ b/src/Service/Athena/src/ValueObject/TableMetadata.php @@ -11,36 +11,50 @@ final class TableMetadata { /** * The name of the table. + * + * @var string */ private $name; /** * The time that the table was created. + * + * @var \DateTimeImmutable|null */ private $createTime; /** * The last time the table was accessed. + * + * @var \DateTimeImmutable|null */ private $lastAccessTime; /** * The type of table. In Athena, only `EXTERNAL_TABLE` is supported. + * + * @var string|null */ private $tableType; /** * A list of the columns in the table. + * + * @var Column[]|null */ private $columns; /** * A list of the partition keys in the table. + * + * @var Column[]|null */ private $partitionKeys; /** * A set of custom key/value pairs for table properties. + * + * @var array|null */ private $parameters; diff --git a/src/Service/Athena/src/ValueObject/WorkGroup.php b/src/Service/Athena/src/ValueObject/WorkGroup.php index e93377a30..55a4ee7f8 100644 --- a/src/Service/Athena/src/ValueObject/WorkGroup.php +++ b/src/Service/Athena/src/ValueObject/WorkGroup.php @@ -18,11 +18,15 @@ final class WorkGroup { /** * The workgroup name. + * + * @var string */ private $name; /** * The state of the workgroup: ENABLED or DISABLED. + * + * @var WorkGroupState::*|null */ private $state; @@ -33,16 +37,22 @@ final class WorkGroup * limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in * `EnforceWorkGroupConfiguration` (true/false) in the `WorkGroupConfiguration`. See * WorkGroupConfiguration$EnforceWorkGroupConfiguration. + * + * @var WorkGroupConfiguration|null */ private $configuration; /** * The workgroup description. + * + * @var string|null */ private $description; /** * The date and time the workgroup was created. + * + * @var \DateTimeImmutable|null */ private $creationTime; diff --git a/src/Service/Athena/src/ValueObject/WorkGroupConfiguration.php b/src/Service/Athena/src/ValueObject/WorkGroupConfiguration.php index 23acccb7e..0c00b45ee 100644 --- a/src/Service/Athena/src/ValueObject/WorkGroupConfiguration.php +++ b/src/Service/Athena/src/ValueObject/WorkGroupConfiguration.php @@ -21,6 +21,8 @@ final class WorkGroupConfiguration * files [^1]. * * [^1]: https://docs.aws.amazon.com/athena/latest/ug/querying.html + * + * @var ResultConfiguration|null */ private $resultConfiguration; @@ -29,16 +31,22 @@ final class WorkGroupConfiguration * settings are used. For more information, see Workgroup Settings Override Client-Side Settings [^1]. * * [^1]: https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html + * + * @var bool|null */ private $enforceWorkGroupConfiguration; /** * Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. + * + * @var bool|null */ private $publishCloudWatchMetricsEnabled; /** * The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. + * + * @var int|null */ private $bytesScannedCutoffPerQuery; @@ -49,28 +57,38 @@ final class WorkGroupConfiguration * Requester Pays Buckets [^1] in the *Amazon Simple Storage Service Developer Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html + * + * @var bool|null */ private $requesterPaysEnabled; /** * The engine version that all queries running on the workgroup use. Queries on the `AmazonAthenaPreviewFunctionality` * workgroup run on the preview engine regardless of this setting. + * + * @var EngineVersion|null */ private $engineVersion; /** * Specifies a user defined JSON string that is passed to the notebook engine. + * + * @var string|null */ private $additionalConfiguration; /** * Role used in a session for accessing the user's resources. + * + * @var string|null */ private $executionRole; /** * Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena * SQL workgroups. + * + * @var CustomerContentEncryptionConfiguration|null */ private $customerContentEncryptionConfiguration; @@ -82,6 +100,8 @@ final class WorkGroupConfiguration * The `EnforceWorkGroupConfiguration` setting takes precedence over the `EnableMinimumEncryptionConfiguration` flag. * This means that if `EnforceWorkGroupConfiguration` is true, the `EnableMinimumEncryptionConfiguration` flag is * ignored, and the workgroup configuration for encryption is used. + * + * @var bool|null */ private $enableMinimumEncryptionConfiguration; diff --git a/src/Service/CloudFormation/src/Result/DescribeStackDriftDetectionStatusOutput.php b/src/Service/CloudFormation/src/Result/DescribeStackDriftDetectionStatusOutput.php index e7affa3a9..dcef38747 100644 --- a/src/Service/CloudFormation/src/Result/DescribeStackDriftDetectionStatusOutput.php +++ b/src/Service/CloudFormation/src/Result/DescribeStackDriftDetectionStatusOutput.php @@ -11,6 +11,8 @@ class DescribeStackDriftDetectionStatusOutput extends Result { /** * The ID of the stack. + * + * @var string */ private $stackId; @@ -19,6 +21,8 @@ class DescribeStackDriftDetectionStatusOutput extends Result * * CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the * number of reports CloudFormation retains for any given stack, and for how long, may vary. + * + * @var string */ private $stackDriftDetectionId; @@ -30,6 +34,8 @@ class DescribeStackDriftDetectionStatusOutput extends Result * - `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs from its expected template configuration. * - `IN_SYNC`: The stack's actual configuration matches its expected template configuration. * - `UNKNOWN`: This value is reserved for future use. + * + * @var StackDriftStatus::*|null */ private $stackDriftStatus; @@ -44,22 +50,30 @@ class DescribeStackDriftDetectionStatusOutput extends Result * - `DETECTION_FAILED`: The stack drift detection operation has failed for at least one resource in the stack. Results * will be available for resources on which CloudFormation successfully completed drift detection. * - `DETECTION_IN_PROGRESS`: The stack drift detection operation is currently in progress. + * + * @var StackDriftDetectionStatus::* */ private $detectionStatus; /** * The reason the stack drift detection operation has its current status. + * + * @var string|null */ private $detectionStatusReason; /** * Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status * of `DETECTION_COMPLETE`. This value will be 0 for stacks whose drift status is `IN_SYNC`. + * + * @var int|null */ private $driftedStackResourceCount; /** * Time at which the stack drift detection operation was initiated. + * + * @var \DateTimeImmutable */ private $timestamp; diff --git a/src/Service/CloudFormation/src/Result/DescribeStackEventsOutput.php b/src/Service/CloudFormation/src/Result/DescribeStackEventsOutput.php index 8cfc3fef5..73f2adc30 100644 --- a/src/Service/CloudFormation/src/Result/DescribeStackEventsOutput.php +++ b/src/Service/CloudFormation/src/Result/DescribeStackEventsOutput.php @@ -18,12 +18,16 @@ class DescribeStackEventsOutput extends Result implements \IteratorAggregate { /** * A list of `StackEvents` structures. + * + * @var StackEvent[] */ private $stackEvents; /** * If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, * this value is null. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/CloudFormation/src/Result/DescribeStacksOutput.php b/src/Service/CloudFormation/src/Result/DescribeStacksOutput.php index eb504b894..eab6eef62 100644 --- a/src/Service/CloudFormation/src/Result/DescribeStacksOutput.php +++ b/src/Service/CloudFormation/src/Result/DescribeStacksOutput.php @@ -25,12 +25,16 @@ class DescribeStacksOutput extends Result implements \IteratorAggregate { /** * A list of stack structures. + * + * @var Stack[] */ private $stacks; /** * If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, * this value is null. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/CloudFormation/src/ValueObject/Output.php b/src/Service/CloudFormation/src/ValueObject/Output.php index 3d7024da1..f4ca6dd6f 100644 --- a/src/Service/CloudFormation/src/ValueObject/Output.php +++ b/src/Service/CloudFormation/src/ValueObject/Output.php @@ -9,21 +9,29 @@ final class Output { /** * The key associated with the output. + * + * @var string|null */ private $outputKey; /** * The value associated with the output. + * + * @var string|null */ private $outputValue; /** * User defined description associated with the output. + * + * @var string|null */ private $description; /** * The name of the export associated with the output. + * + * @var string|null */ private $exportName; diff --git a/src/Service/CloudFormation/src/ValueObject/Parameter.php b/src/Service/CloudFormation/src/ValueObject/Parameter.php index 03c130901..fd0397b35 100644 --- a/src/Service/CloudFormation/src/ValueObject/Parameter.php +++ b/src/Service/CloudFormation/src/ValueObject/Parameter.php @@ -10,17 +10,23 @@ final class Parameter /** * The key associated with the parameter. If you don't specify a key and value for a particular parameter, * CloudFormation uses the default value that's specified in your template. + * + * @var string|null */ private $parameterKey; /** * The input value associated with the parameter. + * + * @var string|null */ private $parameterValue; /** * During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you * specify `true`, do not specify a parameter value. + * + * @var bool|null */ private $usePreviousValue; @@ -29,6 +35,8 @@ final class Parameter * types in the template. * * [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types + * + * @var string|null */ private $resolvedValue; diff --git a/src/Service/CloudFormation/src/ValueObject/RollbackConfiguration.php b/src/Service/CloudFormation/src/ValueObject/RollbackConfiguration.php index a11f511ca..a9fa7c87a 100644 --- a/src/Service/CloudFormation/src/ValueObject/RollbackConfiguration.php +++ b/src/Service/CloudFormation/src/ValueObject/RollbackConfiguration.php @@ -28,6 +28,8 @@ final class RollbackConfiguration * - To remove all currently specified triggers, specify an empty list for this parameter. * * If a specified trigger is missing, the entire stack operation fails and is rolled back. + * + * @var RollbackTrigger[]|null */ private $rollbackTriggers; @@ -47,6 +49,8 @@ final class RollbackConfiguration * the operation completes. * * [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html + * + * @var int|null */ private $monitoringTimeInMinutes; diff --git a/src/Service/CloudFormation/src/ValueObject/RollbackTrigger.php b/src/Service/CloudFormation/src/ValueObject/RollbackTrigger.php index 23b55e2ec..96b28e932 100644 --- a/src/Service/CloudFormation/src/ValueObject/RollbackTrigger.php +++ b/src/Service/CloudFormation/src/ValueObject/RollbackTrigger.php @@ -15,6 +15,8 @@ final class RollbackTrigger * The Amazon Resource Name (ARN) of the rollback trigger. * * If a specified trigger is missing, the entire stack operation fails and is rolled back. + * + * @var string */ private $arn; @@ -24,6 +26,8 @@ final class RollbackTrigger * * [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html * [^2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html + * + * @var string */ private $type; diff --git a/src/Service/CloudFormation/src/ValueObject/Stack.php b/src/Service/CloudFormation/src/ValueObject/Stack.php index 7874e056c..baea45874 100644 --- a/src/Service/CloudFormation/src/ValueObject/Stack.php +++ b/src/Service/CloudFormation/src/ValueObject/Stack.php @@ -13,57 +13,79 @@ final class Stack { /** * Unique identifier of the stack. + * + * @var string|null */ private $stackId; /** * The name associated with the stack. + * + * @var string */ private $stackName; /** * The unique ID of the change set. + * + * @var string|null */ private $changeSetId; /** * A user-defined description associated with the stack. + * + * @var string|null */ private $description; /** * A list of `Parameter` structures. + * + * @var Parameter[]|null */ private $parameters; /** * The time at which the stack was created. + * + * @var \DateTimeImmutable */ private $creationTime; /** * The time the stack was deleted. + * + * @var \DateTimeImmutable|null */ private $deletionTime; /** * The time the stack was last updated. This field will only be returned if the stack has been updated at least once. + * + * @var \DateTimeImmutable|null */ private $lastUpdatedTime; /** * The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the * specified monitoring period afterwards. + * + * @var RollbackConfiguration|null */ private $rollbackConfiguration; /** * Current status of the stack. + * + * @var StackStatus::* */ private $stackStatus; /** * Success/failure message associated with the stack status. + * + * @var string|null */ private $stackStatusReason; @@ -72,37 +94,51 @@ final class Stack * * - `true`: disable rollback. * - `false`: enable rollback. + * + * @var bool|null */ private $disableRollback; /** * Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published. + * + * @var string[]|null */ private $notificationArns; /** * The amount of time within which stack creation should complete. + * + * @var int|null */ private $timeoutInMinutes; /** * The capabilities allowed in the stack. + * + * @var list|null */ private $capabilities; /** * A list of output structures. + * + * @var Output[]|null */ private $outputs; /** * The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. * During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf. + * + * @var string|null */ private $roleArn; /** * A list of `Tag`s that specify information about the stack. + * + * @var Tag[]|null */ private $tags; @@ -114,6 +150,8 @@ final class Stack * * [^1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html * [^2]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html + * + * @var bool|null */ private $enableTerminationProtection; @@ -124,6 +162,8 @@ final class Stack * For more information, see Working with Nested Stacks [^1] in the *CloudFormation User Guide*. * * [^1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html + * + * @var string|null */ private $parentId; @@ -134,6 +174,8 @@ final class Stack * For more information, see Working with Nested Stacks [^1] in the *CloudFormation User Guide*. * * [^1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html + * + * @var string|null */ private $rootId; @@ -143,6 +185,8 @@ final class Stack * Unregulated Configuration Changes to Stacks and Resources [^1]. * * [^1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html + * + * @var StackDriftInformation|null */ private $driftInformation; diff --git a/src/Service/CloudFormation/src/ValueObject/StackDriftInformation.php b/src/Service/CloudFormation/src/ValueObject/StackDriftInformation.php index fda7a796d..f47c0b2d5 100644 --- a/src/Service/CloudFormation/src/ValueObject/StackDriftInformation.php +++ b/src/Service/CloudFormation/src/ValueObject/StackDriftInformation.php @@ -20,12 +20,16 @@ final class StackDriftInformation * - `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs from its expected template configuration. * - `IN_SYNC`: The stack's actual configuration matches its expected template configuration. * - `UNKNOWN`: This value is reserved for future use. + * + * @var StackDriftStatus::* */ private $stackDriftStatus; /** * Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that * support drift detection. + * + * @var \DateTimeImmutable|null */ private $lastCheckTimestamp; diff --git a/src/Service/CloudFormation/src/ValueObject/StackEvent.php b/src/Service/CloudFormation/src/ValueObject/StackEvent.php index 3aba0d011..1b6e45156 100644 --- a/src/Service/CloudFormation/src/ValueObject/StackEvent.php +++ b/src/Service/CloudFormation/src/ValueObject/StackEvent.php @@ -15,26 +15,36 @@ final class StackEvent { /** * The unique ID name of the instance of the stack. + * + * @var string */ private $stackId; /** * The unique ID of this event. + * + * @var string */ private $eventId; /** * The name associated with a stack. + * + * @var string */ private $stackName; /** * The logical name of the resource specified in the template. + * + * @var string|null */ private $logicalResourceId; /** * The name or unique identifier associated with the physical instance of the resource. + * + * @var string|null */ private $physicalResourceId; @@ -43,26 +53,36 @@ final class StackEvent * CloudFormation User Guide.). * * [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html + * + * @var string|null */ private $resourceType; /** * Time the status was updated. + * + * @var \DateTimeImmutable */ private $timestamp; /** * Current status of the resource. + * + * @var ResourceStatus::*|null */ private $resourceStatus; /** * Success/failure message associated with the resource. + * + * @var string|null */ private $resourceStatusReason; /** * BLOB of the properties used to create the resource. + * + * @var string|null */ private $resourceProperties; @@ -77,26 +97,36 @@ final class StackEvent * initiated from the console use the token format *Console-StackOperation-ID*, which helps you easily identify the * stack operation . For example, if you create a stack using the console, each stack event would be assigned the same * token in the following format: `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`. + * + * @var string|null */ private $clientRequestToken; /** * The name of the hook. + * + * @var string|null */ private $hookType; /** * Provides the status of the change set hook. + * + * @var HookStatus::*|null */ private $hookStatus; /** * Provides the reason for the hook status. + * + * @var string|null */ private $hookStatusReason; /** * Invocation points are points in provisioning logic where hooks are initiated. + * + * @var HookInvocationPoint::*|null */ private $hookInvocationPoint; @@ -105,6 +135,8 @@ final class StackEvent * * - `FAIL` Stops provisioning resources. * - `WARN` Allows provisioning to continue with a warning message. + * + * @var HookFailureMode::*|null */ private $hookFailureMode; diff --git a/src/Service/CloudFormation/src/ValueObject/Tag.php b/src/Service/CloudFormation/src/ValueObject/Tag.php index 73e07037c..07cbfcbb0 100644 --- a/src/Service/CloudFormation/src/ValueObject/Tag.php +++ b/src/Service/CloudFormation/src/ValueObject/Tag.php @@ -13,11 +13,15 @@ final class Tag /** * *Required*. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned * by Amazon Web Services (Amazon Web Services) have the reserved prefix: `aws:`. + * + * @var string */ private $key; /** * *Required*. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value. + * + * @var string */ private $value; diff --git a/src/Service/CloudFront/src/Result/CreateInvalidationResult.php b/src/Service/CloudFront/src/Result/CreateInvalidationResult.php index 03ce66e84..0558ea599 100644 --- a/src/Service/CloudFront/src/Result/CreateInvalidationResult.php +++ b/src/Service/CloudFront/src/Result/CreateInvalidationResult.php @@ -15,11 +15,15 @@ class CreateInvalidationResult extends Result { /** * The fully qualified URI of the distribution and invalidation batch request, including the `Invalidation ID`. + * + * @var string|null */ private $location; /** * The invalidation's information. + * + * @var Invalidation|null */ private $invalidation; diff --git a/src/Service/CloudFront/src/ValueObject/Invalidation.php b/src/Service/CloudFront/src/ValueObject/Invalidation.php index c5a83ed8c..482988130 100644 --- a/src/Service/CloudFront/src/ValueObject/Invalidation.php +++ b/src/Service/CloudFront/src/ValueObject/Invalidation.php @@ -11,21 +11,29 @@ final class Invalidation { /** * The identifier for the invalidation request. For example: `IDFDVBD632BHDS5`. + * + * @var string */ private $id; /** * The status of the invalidation request. When the invalidation batch is finished, the status is `Completed`. + * + * @var string */ private $status; /** * The date and time the invalidation request was first made. + * + * @var \DateTimeImmutable */ private $createTime; /** * The current invalidation information for the batch request. + * + * @var InvalidationBatch */ private $invalidationBatch; diff --git a/src/Service/CloudFront/src/ValueObject/InvalidationBatch.php b/src/Service/CloudFront/src/ValueObject/InvalidationBatch.php index f32a7abf3..6812d9e65 100644 --- a/src/Service/CloudFront/src/ValueObject/InvalidationBatch.php +++ b/src/Service/CloudFront/src/ValueObject/InvalidationBatch.php @@ -14,6 +14,8 @@ final class InvalidationBatch * Specifying the Objects to Invalidate [^1] in the *Amazon CloudFront Developer Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects + * + * @var Paths */ private $paths; @@ -29,6 +31,8 @@ final class InvalidationBatch * * If `CallerReference` is a value you already sent in a previous invalidation batch request but the content of any * `Path` is different from the original request, CloudFront returns an `InvalidationBatchAlreadyExists` error. + * + * @var string */ private $callerReference; diff --git a/src/Service/CloudFront/src/ValueObject/Paths.php b/src/Service/CloudFront/src/ValueObject/Paths.php index a506b0325..5d3d66762 100644 --- a/src/Service/CloudFront/src/ValueObject/Paths.php +++ b/src/Service/CloudFront/src/ValueObject/Paths.php @@ -14,11 +14,15 @@ final class Paths { /** * The number of invalidation paths specified for the objects that you want to invalidate. + * + * @var int */ private $quantity; /** * A complex type that contains a list of the paths that you want to invalidate. + * + * @var string[]|null */ private $items; diff --git a/src/Service/CloudWatch/src/Result/GetMetricDataOutput.php b/src/Service/CloudWatch/src/Result/GetMetricDataOutput.php index bc0d4a91c..2b4d14b3c 100644 --- a/src/Service/CloudWatch/src/Result/GetMetricDataOutput.php +++ b/src/Service/CloudWatch/src/Result/GetMetricDataOutput.php @@ -17,11 +17,15 @@ class GetMetricDataOutput extends Result implements \IteratorAggregate { /** * The metrics that are returned, including the metric name, namespace, and dimensions. + * + * @var MetricDataResult[] */ private $metricDataResults; /** * A token that marks the next batch of returned results. + * + * @var string|null */ private $nextToken; @@ -32,6 +36,8 @@ class GetMetricDataOutput extends Result implements \IteratorAggregate * * A message appears here only if it is related to the global `GetMetricData` operation. Any message about a specific * metric returned by the operation appears in the `MetricDataResult` object returned for that metric. + * + * @var MessageData[] */ private $messages; diff --git a/src/Service/CloudWatch/src/Result/GetMetricStatisticsOutput.php b/src/Service/CloudWatch/src/Result/GetMetricStatisticsOutput.php index 056f7a8b7..9e4730603 100644 --- a/src/Service/CloudWatch/src/Result/GetMetricStatisticsOutput.php +++ b/src/Service/CloudWatch/src/Result/GetMetricStatisticsOutput.php @@ -10,11 +10,15 @@ class GetMetricStatisticsOutput extends Result { /** * A label for the specified metric. + * + * @var string|null */ private $label; /** * The data points for the specified metric. + * + * @var Datapoint[] */ private $datapoints; diff --git a/src/Service/CloudWatch/src/Result/ListMetricsOutput.php b/src/Service/CloudWatch/src/Result/ListMetricsOutput.php index 1a9e93020..5df3699b1 100644 --- a/src/Service/CloudWatch/src/Result/ListMetricsOutput.php +++ b/src/Service/CloudWatch/src/Result/ListMetricsOutput.php @@ -17,11 +17,15 @@ class ListMetricsOutput extends Result implements \IteratorAggregate { /** * The metrics that match your request. + * + * @var Metric[] */ private $metrics; /** * The token that marks the start of the next batch of returned results. + * + * @var string|null */ private $nextToken; @@ -30,6 +34,8 @@ class ListMetricsOutput extends Result implements \IteratorAggregate * where the metrics in the returned data are from. * * This field is a 1:1 mapping between each metric that is returned and the ID of the owning account. + * + * @var string[] */ private $owningAccounts; diff --git a/src/Service/CloudWatch/src/ValueObject/Datapoint.php b/src/Service/CloudWatch/src/ValueObject/Datapoint.php index 98c71ec43..dbe66b4d2 100644 --- a/src/Service/CloudWatch/src/ValueObject/Datapoint.php +++ b/src/Service/CloudWatch/src/ValueObject/Datapoint.php @@ -11,41 +11,57 @@ final class Datapoint { /** * The time stamp used for the data point. + * + * @var \DateTimeImmutable|null */ private $timestamp; /** * The number of metric values that contributed to the aggregate value of this data point. + * + * @var float|null */ private $sampleCount; /** * The average of the metric values that correspond to the data point. + * + * @var float|null */ private $average; /** * The sum of the metric values for the data point. + * + * @var float|null */ private $sum; /** * The minimum metric value for the data point. + * + * @var float|null */ private $minimum; /** * The maximum metric value for the data point. + * + * @var float|null */ private $maximum; /** * The standard unit for the data point. + * + * @var StandardUnit::*|null */ private $unit; /** * The percentile statistic for the data point. + * + * @var array|null */ private $extendedStatistics; diff --git a/src/Service/CloudWatch/src/ValueObject/Dimension.php b/src/Service/CloudWatch/src/ValueObject/Dimension.php index 08c96a026..607ba4859 100644 --- a/src/Service/CloudWatch/src/ValueObject/Dimension.php +++ b/src/Service/CloudWatch/src/ValueObject/Dimension.php @@ -18,12 +18,16 @@ final class Dimension * The name of the dimension. Dimension names must contain only ASCII characters, must include at least one * non-whitespace character, and cannot start with a colon (`:`). ASCII control characters are not supported as part of * dimension names. + * + * @var string */ private $name; /** * The value of the dimension. Dimension values must contain only ASCII characters and must include at least one * non-whitespace character. ASCII control characters are not supported as part of dimension values. + * + * @var string */ private $value; diff --git a/src/Service/CloudWatch/src/ValueObject/DimensionFilter.php b/src/Service/CloudWatch/src/ValueObject/DimensionFilter.php index 5c7942921..8d671f7b2 100644 --- a/src/Service/CloudWatch/src/ValueObject/DimensionFilter.php +++ b/src/Service/CloudWatch/src/ValueObject/DimensionFilter.php @@ -11,11 +11,15 @@ final class DimensionFilter { /** * The dimension name to be matched. + * + * @var string */ private $name; /** * The value of the dimension to be matched. + * + * @var string|null */ private $value; diff --git a/src/Service/CloudWatch/src/ValueObject/LabelOptions.php b/src/Service/CloudWatch/src/ValueObject/LabelOptions.php index 863efaa5a..768b6307f 100644 --- a/src/Service/CloudWatch/src/ValueObject/LabelOptions.php +++ b/src/Service/CloudWatch/src/ValueObject/LabelOptions.php @@ -17,6 +17,8 @@ final class LabelOptions * The time zone to use for metric data return in this operation. The format is `+` or `-` followed by four digits. The * first two digits indicate the number of hours ahead or behind of UTC, and the final two digits are the number of * minutes. For example, +0130 indicates a time zone that is 1 hour and 30 minutes ahead of UTC. The default is +0000. + * + * @var string|null */ private $timezone; diff --git a/src/Service/CloudWatch/src/ValueObject/MessageData.php b/src/Service/CloudWatch/src/ValueObject/MessageData.php index 87d7e0c2d..97fb46c1c 100644 --- a/src/Service/CloudWatch/src/ValueObject/MessageData.php +++ b/src/Service/CloudWatch/src/ValueObject/MessageData.php @@ -13,11 +13,15 @@ final class MessageData { /** * The error code or status code associated with the message. + * + * @var string|null */ private $code; /** * The message text. + * + * @var string|null */ private $value; diff --git a/src/Service/CloudWatch/src/ValueObject/Metric.php b/src/Service/CloudWatch/src/ValueObject/Metric.php index b6bba3508..d1f80da96 100644 --- a/src/Service/CloudWatch/src/ValueObject/Metric.php +++ b/src/Service/CloudWatch/src/ValueObject/Metric.php @@ -9,16 +9,22 @@ final class Metric { /** * The namespace of the metric. + * + * @var string|null */ private $namespace; /** * The name of the metric. This is a required field. + * + * @var string|null */ private $metricName; /** * The dimensions for the metric. + * + * @var Dimension[]|null */ private $dimensions; diff --git a/src/Service/CloudWatch/src/ValueObject/MetricDataQuery.php b/src/Service/CloudWatch/src/ValueObject/MetricDataQuery.php index 1705bc1de..63c35e996 100644 --- a/src/Service/CloudWatch/src/ValueObject/MetricDataQuery.php +++ b/src/Service/CloudWatch/src/ValueObject/MetricDataQuery.php @@ -36,6 +36,8 @@ final class MetricDataQuery * `GetMetricData`. If you are performing math expressions on this set of data, this name represents that data and can * serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The * first character must be a lowercase letter. + * + * @var string */ private $id; @@ -44,6 +46,8 @@ final class MetricDataQuery * retrieving a metric and not performing a math expression on returned data. * * Within one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both. + * + * @var MetricStat|null */ private $metricStat; @@ -60,6 +64,8 @@ final class MetricDataQuery * * [^1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage * [^2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax + * + * @var string|null */ private $expression; @@ -72,6 +78,8 @@ final class MetricDataQuery * Labels [^1]. * * [^1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html + * + * @var string|null */ private $label; @@ -82,6 +90,8 @@ final class MetricDataQuery * * When used in `PutMetricAlarm`, specify `true` for the one expression result to use as the alarm. For all other * metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False. + * + * @var bool|null */ private $returnData; @@ -90,6 +100,8 @@ final class MetricDataQuery * short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at * intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics * are those metrics stored by a `PutMetricData` operation that includes a `StorageResolution of 1 second`. + * + * @var int|null */ private $period; @@ -101,6 +113,8 @@ final class MetricDataQuery * * If you are performing a `PutMetricAlarm` operation, use this to specify which account contains the metric that the * alarm is watching. + * + * @var string|null */ private $accountId; diff --git a/src/Service/CloudWatch/src/ValueObject/MetricDataResult.php b/src/Service/CloudWatch/src/ValueObject/MetricDataResult.php index b18094158..96aaee75c 100644 --- a/src/Service/CloudWatch/src/ValueObject/MetricDataResult.php +++ b/src/Service/CloudWatch/src/ValueObject/MetricDataResult.php @@ -12,23 +12,31 @@ final class MetricDataResult { /** * The short name you specified to represent this metric. + * + * @var string|null */ private $id; /** * The human-readable label associated with the data. + * + * @var string|null */ private $label; /** * The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the * number of values and the value for Timestamps[x] is Values[x]. + * + * @var \DateTimeImmutable[]|null */ private $timestamps; /** * The data points for the metric corresponding to `Timestamps`. The number of values always matches the number of * timestamps and the timestamp for Values[x] is Timestamps[x]. + * + * @var float[]|null */ private $values; @@ -37,11 +45,15 @@ final class MetricDataResult * `PartialData` means that an incomplete set of data points were returned. You can use the `NextToken` value that was * returned and repeat your request to get more data points. `NextToken` is not returned if you are performing a math * expression. `InternalError` indicates that an error occurred. Retry your request using `NextToken`, if present. + * + * @var StatusCode::*|null */ private $statusCode; /** * A list of messages with additional information about the data returned. + * + * @var MessageData[]|null */ private $messages; diff --git a/src/Service/CloudWatch/src/ValueObject/MetricDatum.php b/src/Service/CloudWatch/src/ValueObject/MetricDatum.php index 0d5076868..254af3bbd 100644 --- a/src/Service/CloudWatch/src/ValueObject/MetricDatum.php +++ b/src/Service/CloudWatch/src/ValueObject/MetricDatum.php @@ -13,16 +13,22 @@ final class MetricDatum { /** * The name of the metric. + * + * @var string */ private $metricName; /** * The dimensions associated with the metric. + * + * @var Dimension[]|null */ private $dimensions; /** * The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. + * + * @var \DateTimeImmutable|null */ private $timestamp; @@ -32,11 +38,15 @@ final class MetricDatum * Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, * -Infinity) are not supported. + * + * @var float|null */ private $value; /** * The statistical values for the metric. + * + * @var StatisticSet|null */ private $statisticValues; @@ -49,6 +59,8 @@ final class MetricDatum * Although the `Values` array accepts numbers of type `Double`, CloudWatch rejects values that are either too small or * too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, * -Infinity) are not supported. + * + * @var float[]|null */ private $values; @@ -58,6 +70,8 @@ final class MetricDatum * * If you omit the `Counts` array, the default of 1 is used as the value for each count. If you include a `Counts` * array, it must include the same amount of values as the `Values` array. + * + * @var float[]|null */ private $counts; @@ -65,6 +79,8 @@ final class MetricDatum * When you are using a `Put` operation, this defines what unit you want to use when storing the metric. * * In a `Get` operation, this displays the unit that is used for the metric. + * + * @var StandardUnit::*|null */ private $unit; @@ -78,6 +94,8 @@ final class MetricDatum * This field is optional, if you do not specify it the default of 60 is used. * * [^1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics + * + * @var int|null */ private $storageResolution; diff --git a/src/Service/CloudWatch/src/ValueObject/MetricStat.php b/src/Service/CloudWatch/src/ValueObject/MetricStat.php index 412211358..8f2af7d10 100644 --- a/src/Service/CloudWatch/src/ValueObject/MetricStat.php +++ b/src/Service/CloudWatch/src/ValueObject/MetricStat.php @@ -12,6 +12,8 @@ final class MetricStat { /** * The metric to return, including the metric name, namespace, and dimensions. + * + * @var Metric */ private $metric; @@ -27,11 +29,15 @@ final class MetricStat * - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). * - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). * - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour). + * + * @var int */ private $period; /** * The statistic to return. It can include any CloudWatch statistic or extended statistic. + * + * @var string */ private $stat; @@ -42,6 +48,8 @@ final class MetricStat * corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the * operation returns only data that was collected with that unit specified. If you specify a unit that does not match * the data collected, the results of the operation are null. CloudWatch does not perform unit conversions. + * + * @var StandardUnit::*|null */ private $unit; diff --git a/src/Service/CloudWatch/src/ValueObject/StatisticSet.php b/src/Service/CloudWatch/src/ValueObject/StatisticSet.php index 4d3bcc38a..6b2662c63 100644 --- a/src/Service/CloudWatch/src/ValueObject/StatisticSet.php +++ b/src/Service/CloudWatch/src/ValueObject/StatisticSet.php @@ -11,21 +11,29 @@ final class StatisticSet { /** * The number of samples used for the statistic set. + * + * @var float */ private $sampleCount; /** * The sum of values for the sample set. + * + * @var float */ private $sum; /** * The minimum value of the sample set. + * + * @var float */ private $minimum; /** * The maximum value of the sample set. + * + * @var float */ private $maximum; diff --git a/src/Service/CloudWatchLogs/src/Exception/DataAlreadyAcceptedException.php b/src/Service/CloudWatchLogs/src/Exception/DataAlreadyAcceptedException.php index 73c496477..c8649cf4c 100644 --- a/src/Service/CloudWatchLogs/src/Exception/DataAlreadyAcceptedException.php +++ b/src/Service/CloudWatchLogs/src/Exception/DataAlreadyAcceptedException.php @@ -13,6 +13,9 @@ */ final class DataAlreadyAcceptedException extends ClientException { + /** + * @var string|null + */ private $expectedSequenceToken; public function getExpectedSequenceToken(): ?string diff --git a/src/Service/CloudWatchLogs/src/Exception/InvalidSequenceTokenException.php b/src/Service/CloudWatchLogs/src/Exception/InvalidSequenceTokenException.php index 39120edac..9aadcf8f4 100644 --- a/src/Service/CloudWatchLogs/src/Exception/InvalidSequenceTokenException.php +++ b/src/Service/CloudWatchLogs/src/Exception/InvalidSequenceTokenException.php @@ -14,6 +14,9 @@ */ final class InvalidSequenceTokenException extends ClientException { + /** + * @var string|null + */ private $expectedSequenceToken; public function getExpectedSequenceToken(): ?string diff --git a/src/Service/CloudWatchLogs/src/Result/DescribeLogStreamsResponse.php b/src/Service/CloudWatchLogs/src/Result/DescribeLogStreamsResponse.php index 378d2f3db..f965bd2d7 100644 --- a/src/Service/CloudWatchLogs/src/Result/DescribeLogStreamsResponse.php +++ b/src/Service/CloudWatchLogs/src/Result/DescribeLogStreamsResponse.php @@ -16,9 +16,14 @@ class DescribeLogStreamsResponse extends Result implements \IteratorAggregate { /** * The log streams. + * + * @var LogStream[] */ private $logStreams; + /** + * @var string|null + */ private $nextToken; /** diff --git a/src/Service/CloudWatchLogs/src/Result/FilterLogEventsResponse.php b/src/Service/CloudWatchLogs/src/Result/FilterLogEventsResponse.php index 00e2e4f40..379b57c0e 100644 --- a/src/Service/CloudWatchLogs/src/Result/FilterLogEventsResponse.php +++ b/src/Service/CloudWatchLogs/src/Result/FilterLogEventsResponse.php @@ -17,6 +17,8 @@ class FilterLogEventsResponse extends Result implements \IteratorAggregate { /** * The matched events. + * + * @var FilteredLogEvent[] */ private $events; @@ -24,11 +26,15 @@ class FilterLogEventsResponse extends Result implements \IteratorAggregate * **Important** As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list. * * Indicates which log streams have been searched and whether each has been searched completely. + * + * @var SearchedLogStream[] */ private $searchedLogStreams; /** * The token to use when requesting the next set of items. The token expires after 24 hours. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/CloudWatchLogs/src/Result/PutLogEventsResponse.php b/src/Service/CloudWatchLogs/src/Result/PutLogEventsResponse.php index fee3720a5..21ea95808 100644 --- a/src/Service/CloudWatchLogs/src/Result/PutLogEventsResponse.php +++ b/src/Service/CloudWatchLogs/src/Result/PutLogEventsResponse.php @@ -16,11 +16,15 @@ class PutLogEventsResponse extends Result * ! The sequence token is now ignored in `PutLogEvents` actions. `PutLogEvents` actions are always accepted even if the * ! sequence token is not valid. You can use parallel `PutLogEvents` actions on the same log stream and you do not need * ! to wait for the response of a previous `PutLogEvents` action to obtain the `nextSequenceToken` value. + * + * @var string|null */ private $nextSequenceToken; /** * The rejected events. + * + * @var RejectedLogEventsInfo|null */ private $rejectedLogEventsInfo; diff --git a/src/Service/CloudWatchLogs/src/ValueObject/FilteredLogEvent.php b/src/Service/CloudWatchLogs/src/ValueObject/FilteredLogEvent.php index bc7ac7368..571bc3aed 100644 --- a/src/Service/CloudWatchLogs/src/ValueObject/FilteredLogEvent.php +++ b/src/Service/CloudWatchLogs/src/ValueObject/FilteredLogEvent.php @@ -9,26 +9,36 @@ final class FilteredLogEvent { /** * The name of the log stream to which this event belongs. + * + * @var string|null */ private $logStreamName; /** * The time the event occurred, expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`. + * + * @var int|null */ private $timestamp; /** * The data contained in the log event. + * + * @var string|null */ private $message; /** * The time the event was ingested, expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`. + * + * @var int|null */ private $ingestionTime; /** * The ID of the event. + * + * @var string|null */ private $eventId; diff --git a/src/Service/CloudWatchLogs/src/ValueObject/InputLogEvent.php b/src/Service/CloudWatchLogs/src/ValueObject/InputLogEvent.php index b2733c501..51aec18f2 100644 --- a/src/Service/CloudWatchLogs/src/ValueObject/InputLogEvent.php +++ b/src/Service/CloudWatchLogs/src/ValueObject/InputLogEvent.php @@ -12,11 +12,15 @@ final class InputLogEvent { /** * The time the event occurred, expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`. + * + * @var int */ private $timestamp; /** * The raw event message. Each log event can be no larger than 256 KB. + * + * @var string */ private $message; diff --git a/src/Service/CloudWatchLogs/src/ValueObject/LogStream.php b/src/Service/CloudWatchLogs/src/ValueObject/LogStream.php index 07c95caf2..55eda7ee6 100644 --- a/src/Service/CloudWatchLogs/src/ValueObject/LogStream.php +++ b/src/Service/CloudWatchLogs/src/ValueObject/LogStream.php @@ -9,16 +9,22 @@ final class LogStream { /** * The name of the log stream. + * + * @var string|null */ private $logStreamName; /** * The creation time of the stream, expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`. + * + * @var int|null */ private $creationTime; /** * The time of the first event, expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`. + * + * @var int|null */ private $firstEventTimestamp; @@ -26,6 +32,8 @@ final class LogStream * The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of * milliseconds after `Jan 1, 1970 00:00:00 UTC`. The `lastEventTime` value updates on an eventual consistency basis. It * typically updates in less than an hour from ingestion, but in rare situations might take longer. + * + * @var int|null */ private $lastEventTimestamp; @@ -33,6 +41,8 @@ final class LogStream * The ingestion time, expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC` The `lastIngestionTime` * value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in * rare situations might take longer. + * + * @var int|null */ private $lastIngestionTime; @@ -42,11 +52,15 @@ final class LogStream * ! The sequence token is now ignored in `PutLogEvents` actions. `PutLogEvents` actions are always accepted regardless * ! of receiving an invalid sequence token. You don't need to obtain `uploadSequenceToken` to use a `PutLogEvents` * ! action. + * + * @var string|null */ private $uploadSequenceToken; /** * The Amazon Resource Name (ARN) of the log stream. + * + * @var string|null */ private $arn; @@ -55,6 +69,8 @@ final class LogStream * * **Important:** As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as * zero. This change applies only to log streams. The `storedBytes` parameter for log groups is not affected. + * + * @var int|null */ private $storedBytes; diff --git a/src/Service/CloudWatchLogs/src/ValueObject/RejectedLogEventsInfo.php b/src/Service/CloudWatchLogs/src/ValueObject/RejectedLogEventsInfo.php index 4b00dff42..bea0ef84d 100644 --- a/src/Service/CloudWatchLogs/src/ValueObject/RejectedLogEventsInfo.php +++ b/src/Service/CloudWatchLogs/src/ValueObject/RejectedLogEventsInfo.php @@ -9,16 +9,22 @@ final class RejectedLogEventsInfo { /** * The log events that are too new. + * + * @var int|null */ private $tooNewLogEventStartIndex; /** * The log events that are dated too far in the past. + * + * @var int|null */ private $tooOldLogEventEndIndex; /** * The expired log events. + * + * @var int|null */ private $expiredLogEventEndIndex; diff --git a/src/Service/CloudWatchLogs/src/ValueObject/SearchedLogStream.php b/src/Service/CloudWatchLogs/src/ValueObject/SearchedLogStream.php index 803508249..3c4828f4e 100644 --- a/src/Service/CloudWatchLogs/src/ValueObject/SearchedLogStream.php +++ b/src/Service/CloudWatchLogs/src/ValueObject/SearchedLogStream.php @@ -9,11 +9,15 @@ final class SearchedLogStream { /** * The name of the log stream. + * + * @var string|null */ private $logStreamName; /** * Indicates whether all the events in this log stream were searched. + * + * @var bool|null */ private $searchedCompletely; diff --git a/src/Service/CodeBuild/src/Result/BatchGetBuildsOutput.php b/src/Service/CodeBuild/src/Result/BatchGetBuildsOutput.php index 39473851c..6215c90d7 100644 --- a/src/Service/CodeBuild/src/Result/BatchGetBuildsOutput.php +++ b/src/Service/CodeBuild/src/Result/BatchGetBuildsOutput.php @@ -31,11 +31,15 @@ class BatchGetBuildsOutput extends Result { /** * Information about the requested builds. + * + * @var Build[] */ private $builds; /** * The IDs of builds for which information could not be found. + * + * @var string[] */ private $buildsNotFound; diff --git a/src/Service/CodeBuild/src/Result/StartBuildOutput.php b/src/Service/CodeBuild/src/Result/StartBuildOutput.php index f8eda5173..1e34b90e1 100644 --- a/src/Service/CodeBuild/src/Result/StartBuildOutput.php +++ b/src/Service/CodeBuild/src/Result/StartBuildOutput.php @@ -31,6 +31,8 @@ class StartBuildOutput extends Result { /** * Information about the build to be run. + * + * @var Build|null */ private $build; diff --git a/src/Service/CodeBuild/src/Result/StopBuildOutput.php b/src/Service/CodeBuild/src/Result/StopBuildOutput.php index 71d343518..f239120f9 100644 --- a/src/Service/CodeBuild/src/Result/StopBuildOutput.php +++ b/src/Service/CodeBuild/src/Result/StopBuildOutput.php @@ -31,6 +31,8 @@ class StopBuildOutput extends Result { /** * Information about the build. + * + * @var Build|null */ private $build; diff --git a/src/Service/CodeBuild/src/ValueObject/Build.php b/src/Service/CodeBuild/src/ValueObject/Build.php index e652c5352..3f5833e42 100644 --- a/src/Service/CodeBuild/src/ValueObject/Build.php +++ b/src/Service/CodeBuild/src/ValueObject/Build.php @@ -11,32 +11,44 @@ final class Build { /** * The unique ID for the build. + * + * @var string|null */ private $id; /** * The Amazon Resource Name (ARN) of the build. + * + * @var string|null */ private $arn; /** * The number of the build. For each project, the `buildNumber` of its first build is `1`. The `buildNumber` of each * subsequent build is incremented by `1`. If a build is deleted, the `buildNumber` of other builds does not change. + * + * @var int|null */ private $buildNumber; /** * When the build process started, expressed in Unix time format. + * + * @var \DateTimeImmutable|null */ private $startTime; /** * When the build process ended, expressed in Unix time format. + * + * @var \DateTimeImmutable|null */ private $endTime; /** * The current build phase. + * + * @var string|null */ private $currentPhase; @@ -49,6 +61,8 @@ final class Build * - `STOPPED`: The build stopped. * - `SUCCEEDED`: The build succeeded. * - `TIMED_OUT`: The build timed out. + * + * @var StatusType::*|null */ private $buildStatus; @@ -59,6 +73,8 @@ final class Build * For more information, see Source Version Sample with CodeBuild [^1] in the *CodeBuild User Guide*. * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html + * + * @var string|null */ private $sourceVersion; @@ -68,27 +84,37 @@ final class Build * - For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. * - For CodePipeline, the source revision provided by CodePipeline. * - For Amazon S3, this does not apply. + * + * @var string|null */ private $resolvedSourceVersion; /** * The name of the CodeBuild project. + * + * @var string|null */ private $projectName; /** * Information about all previous build phases that are complete and information about any current build phase that is * not yet complete. + * + * @var BuildPhase[]|null */ private $phases; /** * Information about the source code to be built. + * + * @var ProjectSource|null */ private $source; /** * An array of `ProjectSource` objects. + * + * @var ProjectSource[]|null */ private $secondarySources; @@ -104,51 +130,71 @@ final class Build * to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default * branch's HEAD commit ID is used. * - For Amazon S3: the version ID of the object that represents the build input ZIP file to use. + * + * @var ProjectSourceVersion[]|null */ private $secondarySourceVersions; /** * Information about the output artifacts for the build. + * + * @var BuildArtifacts|null */ private $artifacts; /** * An array of `ProjectArtifacts` objects. + * + * @var BuildArtifacts[]|null */ private $secondaryArtifacts; /** * Information about the cache for the build. + * + * @var ProjectCache|null */ private $cache; /** * Information about the build environment for this build. + * + * @var ProjectEnvironment|null */ private $environment; /** * The name of a service role used for this build. + * + * @var string|null */ private $serviceRole; /** * Information about the build's logs in CloudWatch Logs. + * + * @var LogsLocation|null */ private $logs; /** * How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed. + * + * @var int|null */ private $timeoutInMinutes; /** * The number of minutes a build is allowed to be queued before it times out. + * + * @var int|null */ private $queuedTimeoutInMinutes; /** * Whether the build is complete. True if complete; otherwise, false. + * + * @var bool|null */ private $buildComplete; @@ -158,6 +204,8 @@ final class Build * - If CodePipeline started the build, the pipeline's name (for example, `codepipeline/my-demo-pipeline`). * - If an IAM user started the build, the user's name (for example, `MyUserName`). * - If the Jenkins plugin for CodeBuild started the build, the string `CodeBuild-Jenkins-Plugin`. + * + * @var string|null */ private $initiator; @@ -165,11 +213,15 @@ final class Build * If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID * and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You * must provide at least one security group and one subnet ID. + * + * @var VpcConfig|null */ private $vpcConfig; /** * Describes a network interface. + * + * @var NetworkInterface|null */ private $networkInterface; @@ -181,6 +233,8 @@ final class Build * * You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format * `alias/`). + * + * @var string|null */ private $encryptionKey; @@ -192,11 +246,15 @@ final class Build * the *CodePipeline User Guide*. * * [^1]: https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html + * + * @var ExportedEnvironmentVariable[]|null */ private $exportedEnvironmentVariables; /** * An array of the ARNs associated with this build's reports. + * + * @var string[]|null */ private $reportArns; @@ -204,16 +262,22 @@ final class Build * An array of `ProjectFileSystemLocation` objects for a CodeBuild build project. A `ProjectFileSystemLocation` object * specifies the `identifier`, `location`, `mountOptions`, `mountPoint`, and `type` of a file system created using * Amazon Elastic File System. + * + * @var ProjectFileSystemLocation[]|null */ private $fileSystemLocations; /** * Contains information about the debug session for this build. + * + * @var DebugSession|null */ private $debugSession; /** * The ARN of the batch build that this build is a member of, if applicable. + * + * @var string|null */ private $buildBatchArn; diff --git a/src/Service/CodeBuild/src/ValueObject/BuildArtifacts.php b/src/Service/CodeBuild/src/ValueObject/BuildArtifacts.php index f831922ab..ee60addec 100644 --- a/src/Service/CodeBuild/src/ValueObject/BuildArtifacts.php +++ b/src/Service/CodeBuild/src/ValueObject/BuildArtifacts.php @@ -11,6 +11,8 @@ final class BuildArtifacts { /** * Information about the location of the build artifacts. + * + * @var string|null */ private $location; @@ -20,6 +22,8 @@ final class BuildArtifacts * You can use this hash along with a checksum tool to confirm file integrity and authenticity. * * > This value is available only if the build project's `packaging` value is set to `ZIP`. + * + * @var string|null */ private $sha256sum; @@ -29,6 +33,8 @@ final class BuildArtifacts * You can use this hash along with a checksum tool to confirm file integrity and authenticity. * * > This value is available only if the build project's `packaging` value is set to `ZIP`. + * + * @var string|null */ private $md5sum; @@ -36,19 +42,28 @@ final class BuildArtifacts * If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a * buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date * and time to your artifact name so that it is always unique. + * + * @var bool|null */ private $overrideArtifactName; /** * Information that tells you if encryption for build artifacts is disabled. + * + * @var bool|null */ private $encryptionDisabled; /** * An identifier for this artifact definition. + * + * @var string|null */ private $artifactIdentifier; + /** + * @var BucketOwnerAccess::*|null + */ private $bucketOwnerAccess; /** diff --git a/src/Service/CodeBuild/src/ValueObject/BuildPhase.php b/src/Service/CodeBuild/src/ValueObject/BuildPhase.php index feeeb5aa9..1ffb1d3bb 100644 --- a/src/Service/CodeBuild/src/ValueObject/BuildPhase.php +++ b/src/Service/CodeBuild/src/ValueObject/BuildPhase.php @@ -46,6 +46,8 @@ final class BuildPhase * - `UPLOAD_ARTIFACTS`: * * Build output artifacts are being uploaded to the output location. + * + * @var BuildPhaseType::*|null */ private $phaseType; @@ -70,26 +72,36 @@ final class BuildPhase * - `TIMED_OUT`: * * The build phase timed out. + * + * @var StatusType::*|null */ private $phaseStatus; /** * When the build phase started, expressed in Unix time format. + * + * @var \DateTimeImmutable|null */ private $startTime; /** * When the build phase ended, expressed in Unix time format. + * + * @var \DateTimeImmutable|null */ private $endTime; /** * How long, in seconds, between the starting and ending times of the build's phase. + * + * @var int|null */ private $durationInSeconds; /** * Additional information about a build phase, especially to help troubleshoot a failed build. + * + * @var PhaseContext[]|null */ private $contexts; diff --git a/src/Service/CodeBuild/src/ValueObject/BuildStatusConfig.php b/src/Service/CodeBuild/src/ValueObject/BuildStatusConfig.php index 133b9cb91..041a4fa9a 100644 --- a/src/Service/CodeBuild/src/ValueObject/BuildStatusConfig.php +++ b/src/Service/CodeBuild/src/ValueObject/BuildStatusConfig.php @@ -22,6 +22,8 @@ final class BuildStatusConfig * * [^1]: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build * [^2]: https://developer.github.com/v3/repos/statuses/#create-a-commit-status + * + * @var string|null */ private $context; @@ -40,6 +42,8 @@ final class BuildStatusConfig * * [^1]: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build * [^2]: https://developer.github.com/v3/repos/statuses/#create-a-commit-status + * + * @var string|null */ private $targetUrl; diff --git a/src/Service/CodeBuild/src/ValueObject/CloudWatchLogsConfig.php b/src/Service/CodeBuild/src/ValueObject/CloudWatchLogsConfig.php index 5774c94a6..23cdf5e71 100644 --- a/src/Service/CodeBuild/src/ValueObject/CloudWatchLogsConfig.php +++ b/src/Service/CodeBuild/src/ValueObject/CloudWatchLogsConfig.php @@ -15,6 +15,8 @@ final class CloudWatchLogsConfig * * - `ENABLED`: CloudWatch Logs are enabled for this build project. * - `DISABLED`: CloudWatch Logs are not enabled for this build project. + * + * @var LogsConfigStatusType::* */ private $status; @@ -23,6 +25,8 @@ final class CloudWatchLogsConfig * [^1]. * * [^1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html + * + * @var string|null */ private $groupName; @@ -31,6 +35,8 @@ final class CloudWatchLogsConfig * Streams [^1]. * * [^1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html + * + * @var string|null */ private $streamName; diff --git a/src/Service/CodeBuild/src/ValueObject/DebugSession.php b/src/Service/CodeBuild/src/ValueObject/DebugSession.php index 4f3ecd7b2..202f151aa 100644 --- a/src/Service/CodeBuild/src/ValueObject/DebugSession.php +++ b/src/Service/CodeBuild/src/ValueObject/DebugSession.php @@ -12,12 +12,16 @@ final class DebugSession { /** * Specifies if session debugging is enabled for this build. + * + * @var bool|null */ private $sessionEnabled; /** * Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open * this session to examine, control, and resume the build. + * + * @var string|null */ private $sessionTarget; diff --git a/src/Service/CodeBuild/src/ValueObject/EnvironmentVariable.php b/src/Service/CodeBuild/src/ValueObject/EnvironmentVariable.php index 2be342f62..313f61394 100644 --- a/src/Service/CodeBuild/src/ValueObject/EnvironmentVariable.php +++ b/src/Service/CodeBuild/src/ValueObject/EnvironmentVariable.php @@ -12,6 +12,8 @@ final class EnvironmentVariable { /** * The name or key of the environment variable. + * + * @var string */ private $name; @@ -22,6 +24,8 @@ final class EnvironmentVariable * ! Web Services secret key IDs and secret access keys. `PLAINTEXT` environment variables can be displayed in plain * ! text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of * ! type `PARAMETER_STORE` or `SECRETS_MANAGER`. + * + * @var string */ private $value; @@ -36,6 +40,8 @@ final class EnvironmentVariable * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store * [^2]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager + * + * @var EnvironmentVariableType::*|null */ private $type; diff --git a/src/Service/CodeBuild/src/ValueObject/ExportedEnvironmentVariable.php b/src/Service/CodeBuild/src/ValueObject/ExportedEnvironmentVariable.php index b6b6470d7..32bbea914 100644 --- a/src/Service/CodeBuild/src/ValueObject/ExportedEnvironmentVariable.php +++ b/src/Service/CodeBuild/src/ValueObject/ExportedEnvironmentVariable.php @@ -19,11 +19,15 @@ final class ExportedEnvironmentVariable { /** * The name of the exported environment variable. + * + * @var string|null */ private $name; /** * The value assigned to the exported environment variable. + * + * @var string|null */ private $value; diff --git a/src/Service/CodeBuild/src/ValueObject/GitSubmodulesConfig.php b/src/Service/CodeBuild/src/ValueObject/GitSubmodulesConfig.php index f43f49fc4..2aeb46ecd 100644 --- a/src/Service/CodeBuild/src/ValueObject/GitSubmodulesConfig.php +++ b/src/Service/CodeBuild/src/ValueObject/GitSubmodulesConfig.php @@ -11,6 +11,8 @@ final class GitSubmodulesConfig { /** * Set to true to fetch Git submodules for your CodeBuild build project. + * + * @var bool */ private $fetchSubmodules; diff --git a/src/Service/CodeBuild/src/ValueObject/LogsConfig.php b/src/Service/CodeBuild/src/ValueObject/LogsConfig.php index 5e59e3e0b..b487668f8 100644 --- a/src/Service/CodeBuild/src/ValueObject/LogsConfig.php +++ b/src/Service/CodeBuild/src/ValueObject/LogsConfig.php @@ -10,11 +10,15 @@ final class LogsConfig { /** * Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. + * + * @var CloudWatchLogsConfig|null */ private $cloudWatchLogs; /** * Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. + * + * @var S3LogsConfig|null */ private $s3Logs; diff --git a/src/Service/CodeBuild/src/ValueObject/LogsLocation.php b/src/Service/CodeBuild/src/ValueObject/LogsLocation.php index c93a183b7..d3bfcdb7a 100644 --- a/src/Service/CodeBuild/src/ValueObject/LogsLocation.php +++ b/src/Service/CodeBuild/src/ValueObject/LogsLocation.php @@ -9,21 +9,29 @@ final class LogsLocation { /** * The name of the CloudWatch Logs group for the build logs. + * + * @var string|null */ private $groupName; /** * The name of the CloudWatch Logs stream for the build logs. + * + * @var string|null */ private $streamName; /** * The URL to an individual build log in CloudWatch Logs. + * + * @var string|null */ private $deepLink; /** * The URL to a build log in an S3 bucket. + * + * @var string|null */ private $s3DeepLink; @@ -33,6 +41,8 @@ final class LogsLocation * information, see Resources Defined by CloudWatch Logs [^1]. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies + * + * @var string|null */ private $cloudWatchLogsArn; @@ -41,16 +51,22 @@ final class LogsLocation * information, see Resources Defined by Amazon S3 [^1]. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies + * + * @var string|null */ private $s3LogsArn; /** * Information about CloudWatch Logs for a build project. + * + * @var CloudWatchLogsConfig|null */ private $cloudWatchLogs; /** * Information about S3 logs for a build project. + * + * @var S3LogsConfig|null */ private $s3Logs; diff --git a/src/Service/CodeBuild/src/ValueObject/NetworkInterface.php b/src/Service/CodeBuild/src/ValueObject/NetworkInterface.php index aacba63cf..2381d4de9 100644 --- a/src/Service/CodeBuild/src/ValueObject/NetworkInterface.php +++ b/src/Service/CodeBuild/src/ValueObject/NetworkInterface.php @@ -9,11 +9,15 @@ final class NetworkInterface { /** * The ID of the subnet. + * + * @var string|null */ private $subnetId; /** * The ID of the network interface. + * + * @var string|null */ private $networkInterfaceId; diff --git a/src/Service/CodeBuild/src/ValueObject/PhaseContext.php b/src/Service/CodeBuild/src/ValueObject/PhaseContext.php index 1a38548e5..f1b68ff9e 100644 --- a/src/Service/CodeBuild/src/ValueObject/PhaseContext.php +++ b/src/Service/CodeBuild/src/ValueObject/PhaseContext.php @@ -9,11 +9,15 @@ final class PhaseContext { /** * The status code for the context of the build phase. + * + * @var string|null */ private $statusCode; /** * An explanation of the build phase's context. This might include a command ID and an exit code. + * + * @var string|null */ private $message; diff --git a/src/Service/CodeBuild/src/ValueObject/ProjectArtifacts.php b/src/Service/CodeBuild/src/ValueObject/ProjectArtifacts.php index 6cb6880e0..a376b2f8e 100644 --- a/src/Service/CodeBuild/src/ValueObject/ProjectArtifacts.php +++ b/src/Service/CodeBuild/src/ValueObject/ProjectArtifacts.php @@ -22,6 +22,8 @@ final class ProjectArtifacts * * - `NO_ARTIFACTS`: The build project does not produce any build output. * - `S3`: The build project stores build output in Amazon S3. + * + * @var ArtifactsType::* */ private $type; @@ -32,6 +34,8 @@ final class ProjectArtifacts * manages its build output locations instead of CodeBuild. * - If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced. * - If `type` is set to `S3`, this is the name of the output bucket. + * + * @var string|null */ private $location; @@ -45,6 +49,8 @@ final class ProjectArtifacts * * For example, if `path` is set to `MyArtifacts`, `namespaceType` is set to `NONE`, and `name` is set to * `MyArtifact.zip`, the output artifact is stored in the output bucket at `MyArtifacts/MyArtifact.zip`. + * + * @var string|null */ private $path; @@ -63,6 +69,8 @@ final class ProjectArtifacts * * For example, if `path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to * `MyArtifact.zip`, the output artifact is stored in `MyArtifacts//MyArtifact.zip`. + * + * @var ArtifactNamespace::*|null */ private $namespaceType; @@ -83,6 +91,8 @@ final class ProjectArtifacts * the root of the output bucket. * - If `path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to "`/`", the output * artifact is stored in `MyArtifacts/`. + * + * @var string|null */ private $name; @@ -97,6 +107,8 @@ final class ProjectArtifacts * - `NONE`: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if * `packaging` is not specified. * - `ZIP`: CodeBuild creates in the output bucket a ZIP file that contains the build output. + * + * @var ArtifactPackaging::*|null */ private $packaging; @@ -104,20 +116,29 @@ final class ProjectArtifacts * If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a * buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date * and time to your artifact name so that it is always unique. + * + * @var bool|null */ private $overrideArtifactName; /** * Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is * Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. + * + * @var bool|null */ private $encryptionDisabled; /** * An identifier for this artifact definition. + * + * @var string|null */ private $artifactIdentifier; + /** + * @var BucketOwnerAccess::*|null + */ private $bucketOwnerAccess; /** diff --git a/src/Service/CodeBuild/src/ValueObject/ProjectCache.php b/src/Service/CodeBuild/src/ValueObject/ProjectCache.php index b88de7aa7..b056065ec 100644 --- a/src/Service/CodeBuild/src/ValueObject/ProjectCache.php +++ b/src/Service/CodeBuild/src/ValueObject/ProjectCache.php @@ -17,6 +17,8 @@ final class ProjectCache * - `NO_CACHE`: The build project does not use any cache. * - `S3`: The build project reads and writes from and to S3. * - `LOCAL`: The build project stores a cache locally on a build host that is only available to that build host. + * + * @var CacheType::* */ private $type; @@ -25,6 +27,8 @@ final class ProjectCache * * - `NO_CACHE` or `LOCAL`: This value is ignored. * - `S3`: This is the S3 bucket name/prefix. + * + * @var string|null */ private $location; @@ -59,6 +63,8 @@ final class ProjectCache * - Symlinks are used to reference cached directories. * - Cached directories are linked to your build before it downloads its project sources. Cached items are overridden * if a source item has the same name. Directories are specified using cache paths in the buildspec file. + * + * @var list|null */ private $modes; diff --git a/src/Service/CodeBuild/src/ValueObject/ProjectEnvironment.php b/src/Service/CodeBuild/src/ValueObject/ProjectEnvironment.php index daaaf9afd..a0a58599f 100644 --- a/src/Service/CodeBuild/src/ValueObject/ProjectEnvironment.php +++ b/src/Service/CodeBuild/src/ValueObject/ProjectEnvironment.php @@ -31,6 +31,8 @@ final class ProjectEnvironment * For more information, see Build environment compute types [^1] in the *CodeBuild user guide*. * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html + * + * @var EnvironmentType::* */ private $type; @@ -47,6 +49,8 @@ final class ProjectEnvironment * For more information, see Docker images provided by CodeBuild [^1] in the *CodeBuild user guide*. * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html + * + * @var string */ private $image; @@ -70,11 +74,15 @@ final class ProjectEnvironment * For more information, see Build Environment Compute Types [^1] in the *CodeBuild User Guide.* * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html + * + * @var ComputeType::* */ private $computeType; /** * A set of environment variables to make available to builds for this build project. + * + * @var EnvironmentVariable[]|null */ private $environmentVariables; @@ -100,6 +108,8 @@ final class ProjectEnvironment * --storage-driver=overlay&` * * `- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"` + * + * @var bool|null */ private $privilegedMode; @@ -108,11 +118,15 @@ final class ProjectEnvironment * project. For more information, see certificate [^1] in the *CodeBuild User Guide*. * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate + * + * @var string|null */ private $certificate; /** * The credentials for access to a private registry. + * + * @var RegistryCredential|null */ private $registryCredential; @@ -125,6 +139,8 @@ final class ProjectEnvironment * * When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an * CodeBuild curated image, you must use CODEBUILD credentials. + * + * @var ImagePullCredentialsType::*|null */ private $imagePullCredentialsType; diff --git a/src/Service/CodeBuild/src/ValueObject/ProjectFileSystemLocation.php b/src/Service/CodeBuild/src/ValueObject/ProjectFileSystemLocation.php index b1363f00f..b4211d1f5 100644 --- a/src/Service/CodeBuild/src/ValueObject/ProjectFileSystemLocation.php +++ b/src/Service/CodeBuild/src/ValueObject/ProjectFileSystemLocation.php @@ -14,6 +14,8 @@ final class ProjectFileSystemLocation { /** * The type of the file system. The one supported type is `EFS`. + * + * @var FileSystemType::*|null */ private $type; @@ -26,11 +28,15 @@ final class ProjectFileSystemLocation * * The directory path in the format `efs-dns-name:/directory-path` is optional. If you do not specify a directory path, * the location is only the DNS name and CodeBuild mounts the entire file system. + * + * @var string|null */ private $location; /** * The location in the container where you mount the file system. + * + * @var string|null */ private $mountPoint; @@ -40,6 +46,8 @@ final class ProjectFileSystemLocation * environment variable is create named `CODEBUILD_MY_EFS`. * * The `identifier` is used to mount your file system. + * + * @var string|null */ private $identifier; @@ -49,6 +57,8 @@ final class ProjectFileSystemLocation * Options [^1]. * * [^1]: https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html + * + * @var string|null */ private $mountOptions; diff --git a/src/Service/CodeBuild/src/ValueObject/ProjectSource.php b/src/Service/CodeBuild/src/ValueObject/ProjectSource.php index bb3945efe..7ba999f9b 100644 --- a/src/Service/CodeBuild/src/ValueObject/ProjectSource.php +++ b/src/Service/CodeBuild/src/ValueObject/ProjectSource.php @@ -20,6 +20,8 @@ final class ProjectSource * - `GITHUB_ENTERPRISE`: The source code is in a GitHub Enterprise Server repository. * - `NO_SOURCE`: The project does not have input source code. * - `S3`: The source code is in an Amazon S3 bucket. + * + * @var SourceType::* */ private $type; @@ -55,16 +57,22 @@ final class ProjectSource * * If you specify `CODEPIPELINE` for the `Type` property, don't specify this property. For all of the other types, you * must specify `Location`. + * + * @var string|null */ private $location; /** * Information about the Git clone depth for the build project. + * + * @var int|null */ private $gitCloneDepth; /** * Information about the Git submodules configuration for the build project. + * + * @var GitSubmodulesConfig|null */ private $gitSubmodulesConfig; @@ -79,6 +87,8 @@ final class ProjectSource * Name and Storage Location [^1]. * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage + * + * @var string|null */ private $buildspec; @@ -86,6 +96,8 @@ final class ProjectSource * Information about the authorization settings for CodeBuild to access the source code to be built. * * This information is for the CodeBuild console's use only. Your code should not get or set this information directly. + * + * @var SourceAuth|null */ private $auth; @@ -104,23 +116,31 @@ final class ProjectSource * property to take effect. * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html + * + * @var bool|null */ private $reportBuildStatus; /** * Contains information that defines how the build project reports the build status to the source provider. This option * is only used when the source provider is `GITHUB`, `GITHUB_ENTERPRISE`, or `BITBUCKET`. + * + * @var BuildStatusConfig|null */ private $buildStatusConfig; /** * Enable this flag to ignore SSL warnings while connecting to the project source code. + * + * @var bool|null */ private $insecureSsl; /** * An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and * must be less than 128 characters in length. + * + * @var string|null */ private $sourceIdentifier; diff --git a/src/Service/CodeBuild/src/ValueObject/ProjectSourceVersion.php b/src/Service/CodeBuild/src/ValueObject/ProjectSourceVersion.php index 7de272a93..1c36fd658 100644 --- a/src/Service/CodeBuild/src/ValueObject/ProjectSourceVersion.php +++ b/src/Service/CodeBuild/src/ValueObject/ProjectSourceVersion.php @@ -12,6 +12,8 @@ final class ProjectSourceVersion /** * An identifier for a source in the build project. The identifier can only contain alphanumeric characters and * underscores, and must be less than 128 characters in length. + * + * @var string */ private $sourceIdentifier; @@ -31,6 +33,8 @@ final class ProjectSourceVersion * For more information, see Source Version Sample with CodeBuild [^1] in the *CodeBuild User Guide*. * * [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html + * + * @var string */ private $sourceVersion; diff --git a/src/Service/CodeBuild/src/ValueObject/RegistryCredential.php b/src/Service/CodeBuild/src/ValueObject/RegistryCredential.php index 74f32cc9c..93d5d1cd0 100644 --- a/src/Service/CodeBuild/src/ValueObject/RegistryCredential.php +++ b/src/Service/CodeBuild/src/ValueObject/RegistryCredential.php @@ -21,12 +21,16 @@ final class RegistryCredential * The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. * * > The `credential` can use the name of the credentials only if they exist in your current Amazon Web Services Region. + * + * @var string */ private $credential; /** * The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is * for Secrets Manager. + * + * @var CredentialProviderType::* */ private $credentialProvider; diff --git a/src/Service/CodeBuild/src/ValueObject/S3LogsConfig.php b/src/Service/CodeBuild/src/ValueObject/S3LogsConfig.php index 8d849a800..6e8d8f8cc 100644 --- a/src/Service/CodeBuild/src/ValueObject/S3LogsConfig.php +++ b/src/Service/CodeBuild/src/ValueObject/S3LogsConfig.php @@ -16,20 +16,29 @@ final class S3LogsConfig * * - `ENABLED`: S3 build logs are enabled for this build project. * - `DISABLED`: S3 build logs are not enabled for this build project. + * + * @var LogsConfigStatusType::* */ private $status; /** * The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is `my-bucket`, and your path * prefix is `build-log`, then acceptable formats are `my-bucket/build-log` or `arn:aws:s3:::my-bucket/build-log`. + * + * @var string|null */ private $location; /** * Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. + * + * @var bool|null */ private $encryptionDisabled; + /** + * @var BucketOwnerAccess::*|null + */ private $bucketOwnerAccess; /** diff --git a/src/Service/CodeBuild/src/ValueObject/SourceAuth.php b/src/Service/CodeBuild/src/ValueObject/SourceAuth.php index 0c722b7d3..0eb48a358 100644 --- a/src/Service/CodeBuild/src/ValueObject/SourceAuth.php +++ b/src/Service/CodeBuild/src/ValueObject/SourceAuth.php @@ -16,11 +16,15 @@ final class SourceAuth * > This data type is deprecated and is no longer accurate or used. * * The authorization type to use. The only valid value is `OAUTH`, which represents the OAuth authorization type. + * + * @var SourceAuthType::* */ private $type; /** * The resource value that applies to the specified authorization type. + * + * @var string|null */ private $resource; diff --git a/src/Service/CodeBuild/src/ValueObject/VpcConfig.php b/src/Service/CodeBuild/src/ValueObject/VpcConfig.php index 03781938c..8996c4115 100644 --- a/src/Service/CodeBuild/src/ValueObject/VpcConfig.php +++ b/src/Service/CodeBuild/src/ValueObject/VpcConfig.php @@ -9,16 +9,22 @@ final class VpcConfig { /** * The ID of the Amazon VPC. + * + * @var string|null */ private $vpcId; /** * A list of one or more subnet IDs in your Amazon VPC. + * + * @var string[]|null */ private $subnets; /** * A list of one or more security groups IDs in your Amazon VPC. + * + * @var string[]|null */ private $securityGroupIds; diff --git a/src/Service/CodeCommit/src/Result/CreateRepositoryOutput.php b/src/Service/CodeCommit/src/Result/CreateRepositoryOutput.php index f8c97cbaf..73a63076a 100644 --- a/src/Service/CodeCommit/src/Result/CreateRepositoryOutput.php +++ b/src/Service/CodeCommit/src/Result/CreateRepositoryOutput.php @@ -13,6 +13,8 @@ class CreateRepositoryOutput extends Result { /** * Information about the newly created repository. + * + * @var RepositoryMetadata|null */ private $repositoryMetadata; diff --git a/src/Service/CodeCommit/src/Result/DeleteRepositoryOutput.php b/src/Service/CodeCommit/src/Result/DeleteRepositoryOutput.php index af99fc633..13b8d5a1d 100644 --- a/src/Service/CodeCommit/src/Result/DeleteRepositoryOutput.php +++ b/src/Service/CodeCommit/src/Result/DeleteRepositoryOutput.php @@ -12,6 +12,8 @@ class DeleteRepositoryOutput extends Result { /** * The ID of the repository that was deleted. + * + * @var string|null */ private $repositoryId; diff --git a/src/Service/CodeCommit/src/Result/GetBlobOutput.php b/src/Service/CodeCommit/src/Result/GetBlobOutput.php index 8f9e8fc44..5c104406c 100644 --- a/src/Service/CodeCommit/src/Result/GetBlobOutput.php +++ b/src/Service/CodeCommit/src/Result/GetBlobOutput.php @@ -12,6 +12,8 @@ class GetBlobOutput extends Result { /** * The content of the blob, usually a file. + * + * @var string */ private $content; diff --git a/src/Service/CodeCommit/src/Result/GetBranchOutput.php b/src/Service/CodeCommit/src/Result/GetBranchOutput.php index 240e3c750..21011eef6 100644 --- a/src/Service/CodeCommit/src/Result/GetBranchOutput.php +++ b/src/Service/CodeCommit/src/Result/GetBranchOutput.php @@ -13,6 +13,8 @@ class GetBranchOutput extends Result { /** * The name of the branch. + * + * @var BranchInfo|null */ private $branch; diff --git a/src/Service/CodeCommit/src/Result/GetCommitOutput.php b/src/Service/CodeCommit/src/Result/GetCommitOutput.php index deefc884e..60c2fb10e 100644 --- a/src/Service/CodeCommit/src/Result/GetCommitOutput.php +++ b/src/Service/CodeCommit/src/Result/GetCommitOutput.php @@ -14,6 +14,8 @@ class GetCommitOutput extends Result { /** * A commit data type object that contains information about the specified commit. + * + * @var Commit */ private $commit; diff --git a/src/Service/CodeCommit/src/Result/GetDifferencesOutput.php b/src/Service/CodeCommit/src/Result/GetDifferencesOutput.php index 2529226d4..1212205a9 100644 --- a/src/Service/CodeCommit/src/Result/GetDifferencesOutput.php +++ b/src/Service/CodeCommit/src/Result/GetDifferencesOutput.php @@ -18,11 +18,15 @@ class GetDifferencesOutput extends Result implements \IteratorAggregate /** * A data type object that contains information about the differences, including whether the difference is added, * modified, or deleted (A, D, M). + * + * @var Difference[] */ private $differences; /** * An enumeration token that can be used in a request to return the next batch of the results. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/CodeCommit/src/Result/ListRepositoriesOutput.php b/src/Service/CodeCommit/src/Result/ListRepositoriesOutput.php index 340837122..a31514f91 100644 --- a/src/Service/CodeCommit/src/Result/ListRepositoriesOutput.php +++ b/src/Service/CodeCommit/src/Result/ListRepositoriesOutput.php @@ -18,6 +18,8 @@ class ListRepositoriesOutput extends Result implements \IteratorAggregate { /** * Lists the repositories called by the list repositories operation. + * + * @var RepositoryNameIdPair[] */ private $repositories; @@ -25,6 +27,8 @@ class ListRepositoriesOutput extends Result implements \IteratorAggregate * An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list * repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is * retrieved. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/CodeCommit/src/Result/PutRepositoryTriggersOutput.php b/src/Service/CodeCommit/src/Result/PutRepositoryTriggersOutput.php index 267decc27..55306a55b 100644 --- a/src/Service/CodeCommit/src/Result/PutRepositoryTriggersOutput.php +++ b/src/Service/CodeCommit/src/Result/PutRepositoryTriggersOutput.php @@ -12,6 +12,8 @@ class PutRepositoryTriggersOutput extends Result { /** * The system-generated unique ID for the create or update operation. + * + * @var string|null */ private $configurationId; diff --git a/src/Service/CodeCommit/src/ValueObject/BlobMetadata.php b/src/Service/CodeCommit/src/ValueObject/BlobMetadata.php index 11c14d3ea..f956a8631 100644 --- a/src/Service/CodeCommit/src/ValueObject/BlobMetadata.php +++ b/src/Service/CodeCommit/src/ValueObject/BlobMetadata.php @@ -9,11 +9,15 @@ final class BlobMetadata { /** * The full ID of the blob. + * + * @var string|null */ private $blobId; /** * The path to the blob and associated file name, if any. + * + * @var string|null */ private $path; @@ -24,6 +28,8 @@ final class BlobMetadata * - `100755` indicates read/write/execute * - `160000` indicates a submodule * - `120000` indicates a symlink + * + * @var string|null */ private $mode; diff --git a/src/Service/CodeCommit/src/ValueObject/BranchInfo.php b/src/Service/CodeCommit/src/ValueObject/BranchInfo.php index 6f485a56c..d49903a1a 100644 --- a/src/Service/CodeCommit/src/ValueObject/BranchInfo.php +++ b/src/Service/CodeCommit/src/ValueObject/BranchInfo.php @@ -9,11 +9,15 @@ final class BranchInfo { /** * The name of the branch. + * + * @var string|null */ private $branchName; /** * The ID of the last commit made to the branch. + * + * @var string|null */ private $commitId; diff --git a/src/Service/CodeCommit/src/ValueObject/Commit.php b/src/Service/CodeCommit/src/ValueObject/Commit.php index 170a7edd7..c2e0ccdc9 100644 --- a/src/Service/CodeCommit/src/ValueObject/Commit.php +++ b/src/Service/CodeCommit/src/ValueObject/Commit.php @@ -9,27 +9,37 @@ final class Commit { /** * The full SHA ID of the specified commit. + * + * @var string|null */ private $commitId; /** * Tree information for the specified commit. + * + * @var string|null */ private $treeId; /** * A list of parent commits for the specified commit. Each parent commit ID is the full commit ID. + * + * @var string[]|null */ private $parents; /** * The commit message associated with the specified commit. + * + * @var string|null */ private $message; /** * Information about the author of the specified commit. Information includes the date in timestamp format with GMT * offset, the name of the author, and the email address for the author, as configured in Git. + * + * @var UserInfo|null */ private $author; @@ -42,11 +52,15 @@ final class Commit * [^1] in Pro Git by Scott Chacon and Ben Straub. * * [^1]: http://git-scm.com/book/ch2-3.html + * + * @var UserInfo|null */ private $committer; /** * Any other data associated with the specified commit. + * + * @var string|null */ private $additionalData; diff --git a/src/Service/CodeCommit/src/ValueObject/Difference.php b/src/Service/CodeCommit/src/ValueObject/Difference.php index 001e04546..41be53049 100644 --- a/src/Service/CodeCommit/src/ValueObject/Difference.php +++ b/src/Service/CodeCommit/src/ValueObject/Difference.php @@ -11,16 +11,22 @@ final class Difference { /** * Information about a `beforeBlob` data type object, including the ID, the file mode permission code, and the path. + * + * @var BlobMetadata|null */ private $beforeBlob; /** * Information about an `afterBlob` data type object, including the ID, the file mode permission code, and the path. + * + * @var BlobMetadata|null */ private $afterBlob; /** * Whether the change type of the difference is an addition (A), deletion (D), or modification (M). + * + * @var ChangeTypeEnum::*|null */ private $changeType; diff --git a/src/Service/CodeCommit/src/ValueObject/RepositoryMetadata.php b/src/Service/CodeCommit/src/ValueObject/RepositoryMetadata.php index ca86e4412..f1e7c92a4 100644 --- a/src/Service/CodeCommit/src/ValueObject/RepositoryMetadata.php +++ b/src/Service/CodeCommit/src/ValueObject/RepositoryMetadata.php @@ -9,51 +9,71 @@ final class RepositoryMetadata { /** * The ID of the AWS account associated with the repository. + * + * @var string|null */ private $accountId; /** * The ID of the repository. + * + * @var string|null */ private $repositoryId; /** * The repository's name. + * + * @var string|null */ private $repositoryName; /** * A comment or description about the repository. + * + * @var string|null */ private $repositoryDescription; /** * The repository's default branch name. + * + * @var string|null */ private $defaultBranch; /** * The date and time the repository was last modified, in timestamp format. + * + * @var \DateTimeImmutable|null */ private $lastModifiedDate; /** * The date and time the repository was created, in timestamp format. + * + * @var \DateTimeImmutable|null */ private $creationDate; /** * The URL to use for cloning the repository over HTTPS. + * + * @var string|null */ private $cloneUrlHttp; /** * The URL to use for cloning the repository over SSH. + * + * @var string|null */ private $cloneUrlSsh; /** * The Amazon Resource Name (ARN) of the repository. + * + * @var string|null */ private $arn; diff --git a/src/Service/CodeCommit/src/ValueObject/RepositoryNameIdPair.php b/src/Service/CodeCommit/src/ValueObject/RepositoryNameIdPair.php index 86dc6479e..55653bf8e 100644 --- a/src/Service/CodeCommit/src/ValueObject/RepositoryNameIdPair.php +++ b/src/Service/CodeCommit/src/ValueObject/RepositoryNameIdPair.php @@ -9,11 +9,15 @@ final class RepositoryNameIdPair { /** * The name associated with the repository. + * + * @var string|null */ private $repositoryName; /** * The ID associated with the repository. + * + * @var string|null */ private $repositoryId; diff --git a/src/Service/CodeCommit/src/ValueObject/RepositoryTrigger.php b/src/Service/CodeCommit/src/ValueObject/RepositoryTrigger.php index 47dddbe69..8acd01111 100644 --- a/src/Service/CodeCommit/src/ValueObject/RepositoryTrigger.php +++ b/src/Service/CodeCommit/src/ValueObject/RepositoryTrigger.php @@ -12,16 +12,22 @@ final class RepositoryTrigger { /** * The name of the trigger. + * + * @var string */ private $name; /** * The ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS). + * + * @var string */ private $destinationArn; /** * Any custom data associated with the trigger to be included in the information sent to the target of the trigger. + * + * @var string|null */ private $customData; @@ -30,6 +36,8 @@ final class RepositoryTrigger * branches. * * > Although no content is required in the array, you must include the array itself. + * + * @var string[]|null */ private $branches; @@ -38,6 +46,8 @@ final class RepositoryTrigger * through Amazon SNS. * * > The valid value "all" cannot be used with any other values. + * + * @var list */ private $events; diff --git a/src/Service/CodeCommit/src/ValueObject/UserInfo.php b/src/Service/CodeCommit/src/ValueObject/UserInfo.php index 2d1a6d1ef..59a725123 100644 --- a/src/Service/CodeCommit/src/ValueObject/UserInfo.php +++ b/src/Service/CodeCommit/src/ValueObject/UserInfo.php @@ -9,16 +9,22 @@ final class UserInfo { /** * The name of the user who made the specified commit. + * + * @var string|null */ private $name; /** * The email address associated with the user who made the commit, if any. + * + * @var string|null */ private $email; /** * The date when the specified commit was commited, in timestamp format with GMT offset. + * + * @var string|null */ private $date; diff --git a/src/Service/CodeDeploy/src/Result/CreateDeploymentOutput.php b/src/Service/CodeDeploy/src/Result/CreateDeploymentOutput.php index 1ebd5deac..b3d680984 100644 --- a/src/Service/CodeDeploy/src/Result/CreateDeploymentOutput.php +++ b/src/Service/CodeDeploy/src/Result/CreateDeploymentOutput.php @@ -12,6 +12,8 @@ class CreateDeploymentOutput extends Result { /** * The unique ID of a deployment. + * + * @var string|null */ private $deploymentId; diff --git a/src/Service/CodeDeploy/src/Result/GetDeploymentOutput.php b/src/Service/CodeDeploy/src/Result/GetDeploymentOutput.php index 8091c101a..08a23d958 100644 --- a/src/Service/CodeDeploy/src/Result/GetDeploymentOutput.php +++ b/src/Service/CodeDeploy/src/Result/GetDeploymentOutput.php @@ -39,6 +39,8 @@ class GetDeploymentOutput extends Result { /** * Information about the deployment. + * + * @var DeploymentInfo|null */ private $deploymentInfo; diff --git a/src/Service/CodeDeploy/src/Result/PutLifecycleEventHookExecutionStatusOutput.php b/src/Service/CodeDeploy/src/Result/PutLifecycleEventHookExecutionStatusOutput.php index 561d50515..c79cebb9b 100644 --- a/src/Service/CodeDeploy/src/Result/PutLifecycleEventHookExecutionStatusOutput.php +++ b/src/Service/CodeDeploy/src/Result/PutLifecycleEventHookExecutionStatusOutput.php @@ -10,6 +10,8 @@ class PutLifecycleEventHookExecutionStatusOutput extends Result /** * The execution ID of the lifecycle event hook. A hook is specified in the `hooks` section of the deployment's AppSpec * file. + * + * @var string|null */ private $lifecycleEventHookExecutionId; diff --git a/src/Service/CodeDeploy/src/ValueObject/Alarm.php b/src/Service/CodeDeploy/src/ValueObject/Alarm.php index 1f80d9334..bea1e7a23 100644 --- a/src/Service/CodeDeploy/src/ValueObject/Alarm.php +++ b/src/Service/CodeDeploy/src/ValueObject/Alarm.php @@ -9,6 +9,8 @@ final class Alarm { /** * The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms. + * + * @var string|null */ private $name; diff --git a/src/Service/CodeDeploy/src/ValueObject/AlarmConfiguration.php b/src/Service/CodeDeploy/src/ValueObject/AlarmConfiguration.php index 7aac0510e..e6cc8debb 100644 --- a/src/Service/CodeDeploy/src/ValueObject/AlarmConfiguration.php +++ b/src/Service/CodeDeploy/src/ValueObject/AlarmConfiguration.php @@ -9,6 +9,8 @@ final class AlarmConfiguration { /** * Indicates whether the alarm configuration is enabled. + * + * @var bool|null */ private $enabled; @@ -18,11 +20,15 @@ final class AlarmConfiguration * * - `true`: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch. * - `false`: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch. + * + * @var bool|null */ private $ignorePollAlarmFailure; /** * A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added. + * + * @var Alarm[]|null */ private $alarms; diff --git a/src/Service/CodeDeploy/src/ValueObject/AppSpecContent.php b/src/Service/CodeDeploy/src/ValueObject/AppSpecContent.php index d5264763a..f3e644921 100644 --- a/src/Service/CodeDeploy/src/ValueObject/AppSpecContent.php +++ b/src/Service/CodeDeploy/src/ValueObject/AppSpecContent.php @@ -21,11 +21,15 @@ final class AppSpecContent * * For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as * `BeforeInstall`, during a deployment. + * + * @var string|null */ private $content; /** * The SHA256 hash value of the revision content. + * + * @var string|null */ private $sha256; diff --git a/src/Service/CodeDeploy/src/ValueObject/AutoRollbackConfiguration.php b/src/Service/CodeDeploy/src/ValueObject/AutoRollbackConfiguration.php index 497487c3b..4380bbcbe 100644 --- a/src/Service/CodeDeploy/src/ValueObject/AutoRollbackConfiguration.php +++ b/src/Service/CodeDeploy/src/ValueObject/AutoRollbackConfiguration.php @@ -13,11 +13,15 @@ final class AutoRollbackConfiguration { /** * Indicates whether a defined automatic rollback configuration is currently enabled. + * + * @var bool|null */ private $enabled; /** * The event type or types that trigger a rollback. + * + * @var list|null */ private $events; diff --git a/src/Service/CodeDeploy/src/ValueObject/BlueGreenDeploymentConfiguration.php b/src/Service/CodeDeploy/src/ValueObject/BlueGreenDeploymentConfiguration.php index 1289daad2..6a0db5909 100644 --- a/src/Service/CodeDeploy/src/ValueObject/BlueGreenDeploymentConfiguration.php +++ b/src/Service/CodeDeploy/src/ValueObject/BlueGreenDeploymentConfiguration.php @@ -9,17 +9,23 @@ final class BlueGreenDeploymentConfiguration { /** * Information about whether to terminate instances in the original fleet during a blue/green deployment. + * + * @var BlueInstanceTerminationOption|null */ private $terminateBlueInstancesOnDeploymentSuccess; /** * Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green * deployment. + * + * @var DeploymentReadyOption|null */ private $deploymentReadyOption; /** * Information about how instances are provisioned for a replacement environment in a blue/green deployment. + * + * @var GreenFleetProvisioningOption|null */ private $greenFleetProvisioningOption; diff --git a/src/Service/CodeDeploy/src/ValueObject/BlueInstanceTerminationOption.php b/src/Service/CodeDeploy/src/ValueObject/BlueInstanceTerminationOption.php index 7efe075eb..dd05674c1 100644 --- a/src/Service/CodeDeploy/src/ValueObject/BlueInstanceTerminationOption.php +++ b/src/Service/CodeDeploy/src/ValueObject/BlueInstanceTerminationOption.php @@ -16,6 +16,8 @@ final class BlueInstanceTerminationOption * - `TERMINATE`: Instances are terminated after a specified wait time. * - `KEEP_ALIVE`: Instances are left running after they are deregistered from the load balancer and removed from the * deployment group. + * + * @var InstanceAction::*|null */ private $action; @@ -27,6 +29,8 @@ final class BlueInstanceTerminationOption * ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. * * The maximum setting is 2880 minutes (2 days). + * + * @var int|null */ private $terminationWaitTimeInMinutes; diff --git a/src/Service/CodeDeploy/src/ValueObject/DeploymentInfo.php b/src/Service/CodeDeploy/src/ValueObject/DeploymentInfo.php index 33bd1e2d0..e2e579f9f 100644 --- a/src/Service/CodeDeploy/src/ValueObject/DeploymentInfo.php +++ b/src/Service/CodeDeploy/src/ValueObject/DeploymentInfo.php @@ -14,47 +14,65 @@ final class DeploymentInfo { /** * The application name. + * + * @var string|null */ private $applicationName; /** * The deployment group name. + * + * @var string|null */ private $deploymentGroupName; /** * The deployment configuration name. + * + * @var string|null */ private $deploymentConfigName; /** * The unique ID of a deployment. + * + * @var string|null */ private $deploymentId; /** * Information about the application revision that was deployed to the deployment group before the most recent * successful deployment. + * + * @var RevisionLocation|null */ private $previousRevision; /** * Information about the location of stored application artifacts and the service from which to retrieve them. + * + * @var RevisionLocation|null */ private $revision; /** * The current state of the deployment as a whole. + * + * @var DeploymentStatus::*|null */ private $status; /** * Information about any error associated with this deployment. + * + * @var ErrorInformation|null */ private $errorInformation; /** * A timestamp that indicates when the deployment was created. + * + * @var \DateTimeImmutable|null */ private $createTime; @@ -63,21 +81,29 @@ final class DeploymentInfo * * In some cases, the reported value of the start time might be later than the complete time. This is due to differences * in the clock settings of backend servers that participate in the deployment process. + * + * @var \DateTimeImmutable|null */ private $startTime; /** * A timestamp that indicates when the deployment was complete. + * + * @var \DateTimeImmutable|null */ private $completeTime; /** * A summary of the deployment status of the instances in the deployment. + * + * @var DeploymentOverview|null */ private $deploymentOverview; /** * A comment about the deployment. + * + * @var string|null */ private $description; @@ -89,6 +115,8 @@ final class DeploymentInfo * - `codeDeployRollback`: A rollback process created the deployment. * - `CodeDeployAutoUpdate`: An auto-update process created the deployment when it detected outdated Amazon EC2 * instances. + * + * @var DeploymentCreator::*|null */ private $creator; @@ -110,32 +138,44 @@ final class DeploymentInfo * If the cause of the failure is a script from the last successful deployment that will never run successfully, create * a new deployment and use `ignoreApplicationStopFailures` to specify that the `ApplicationStop`, `BeforeBlockTraffic`, * and `AfterBlockTraffic` failures should be ignored. + * + * @var bool|null */ private $ignoreApplicationStopFailures; /** * Information about the automatic rollback configuration associated with the deployment. + * + * @var AutoRollbackConfiguration|null */ private $autoRollbackConfiguration; /** * Indicates whether only instances that are not running the latest application revision are to be deployed to. + * + * @var bool|null */ private $updateOutdatedInstancesOnly; /** * Information about a deployment rollback. + * + * @var RollbackInfo|null */ private $rollbackInfo; /** * Information about the type of deployment, either in-place or blue/green, you want to run and whether to route * deployment traffic behind a load balancer. + * + * @var DeploymentStyle|null */ private $deploymentStyle; /** * Information about the instances that belong to the replacement environment in a blue/green deployment. + * + * @var TargetInstances|null */ private $targetInstances; @@ -143,22 +183,30 @@ final class DeploymentInfo * Indicates whether the wait period set for the termination of instances in the original environment has started. * Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period * starts. + * + * @var bool|null */ private $instanceTerminationWaitTimeStarted; /** * Information about blue/green deployment options for this deployment. + * + * @var BlueGreenDeploymentConfiguration|null */ private $blueGreenDeploymentConfiguration; /** * Information about the load balancer used in the deployment. + * + * @var LoadBalancerInfo|null */ private $loadBalancerInfo; /** * Provides information about the results of a deployment, such as whether instances in the original environment in a * blue/green deployment were not terminated. + * + * @var string|null */ private $additionalDeploymentStatusInfo; @@ -170,26 +218,40 @@ final class DeploymentInfo * - `OVERWRITE`: The version of the file from the application revision currently being deployed replaces the version * already on the instance. * - `RETAIN`: The version of the file already on the instance is kept and used as part of the new deployment. + * + * @var FileExistsBehavior::*|null */ private $fileExistsBehavior; /** * Messages that contain information about the status of a deployment. + * + * @var string[]|null */ private $deploymentStatusMessages; /** * The destination platform type for the deployment (`Lambda`, `Server`, or `ECS`). + * + * @var ComputePlatform::*|null */ private $computePlatform; /** * The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment. + * + * @var string|null */ private $externalId; + /** + * @var RelatedDeployments|null + */ private $relatedDeployments; + /** + * @var AlarmConfiguration|null + */ private $overrideAlarmConfiguration; /** diff --git a/src/Service/CodeDeploy/src/ValueObject/DeploymentOverview.php b/src/Service/CodeDeploy/src/ValueObject/DeploymentOverview.php index 631059af0..8877c3c69 100644 --- a/src/Service/CodeDeploy/src/ValueObject/DeploymentOverview.php +++ b/src/Service/CodeDeploy/src/ValueObject/DeploymentOverview.php @@ -9,31 +9,43 @@ final class DeploymentOverview { /** * The number of instances in the deployment in a pending state. + * + * @var int|null */ private $pending; /** * The number of instances in which the deployment is in progress. + * + * @var int|null */ private $inProgress; /** * The number of instances in the deployment to which revisions have been successfully deployed. + * + * @var int|null */ private $succeeded; /** * The number of instances in the deployment in a failed state. + * + * @var int|null */ private $failed; /** * The number of instances in the deployment in a skipped state. + * + * @var int|null */ private $skipped; /** * The number of instances in a replacement environment ready to receive traffic in a blue/green deployment. + * + * @var int|null */ private $ready; diff --git a/src/Service/CodeDeploy/src/ValueObject/DeploymentReadyOption.php b/src/Service/CodeDeploy/src/ValueObject/DeploymentReadyOption.php index b83e67c0a..9f70b856e 100644 --- a/src/Service/CodeDeploy/src/ValueObject/DeploymentReadyOption.php +++ b/src/Service/CodeDeploy/src/ValueObject/DeploymentReadyOption.php @@ -18,12 +18,16 @@ final class DeploymentReadyOption * - STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using * ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment * status is changed to Stopped. + * + * @var DeploymentReadyAction::*|null */ private $actionOnTimeout; /** * The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not * started manually. Applies only to the `STOP_DEPLOYMENT` option for `actionOnTimeout`. + * + * @var int|null */ private $waitTimeInMinutes; diff --git a/src/Service/CodeDeploy/src/ValueObject/DeploymentStyle.php b/src/Service/CodeDeploy/src/ValueObject/DeploymentStyle.php index a9c45bc22..8c0585826 100644 --- a/src/Service/CodeDeploy/src/ValueObject/DeploymentStyle.php +++ b/src/Service/CodeDeploy/src/ValueObject/DeploymentStyle.php @@ -13,11 +13,15 @@ final class DeploymentStyle { /** * Indicates whether to run an in-place deployment or a blue/green deployment. + * + * @var DeploymentType::*|null */ private $deploymentType; /** * Indicates whether to route deployment traffic behind a load balancer. + * + * @var DeploymentOption::*|null */ private $deploymentOption; diff --git a/src/Service/CodeDeploy/src/ValueObject/EC2TagFilter.php b/src/Service/CodeDeploy/src/ValueObject/EC2TagFilter.php index 5c7bf5f2f..708d3294b 100644 --- a/src/Service/CodeDeploy/src/ValueObject/EC2TagFilter.php +++ b/src/Service/CodeDeploy/src/ValueObject/EC2TagFilter.php @@ -12,11 +12,15 @@ final class EC2TagFilter { /** * The tag filter key. + * + * @var string|null */ private $key; /** * The tag filter value. + * + * @var string|null */ private $value; @@ -26,6 +30,8 @@ final class EC2TagFilter * - `KEY_ONLY`: Key only. * - `VALUE_ONLY`: Value only. * - `KEY_AND_VALUE`: Key and value. + * + * @var EC2TagFilterType::*|null */ private $type; diff --git a/src/Service/CodeDeploy/src/ValueObject/EC2TagSet.php b/src/Service/CodeDeploy/src/ValueObject/EC2TagSet.php index 1fd278860..7dd527825 100644 --- a/src/Service/CodeDeploy/src/ValueObject/EC2TagSet.php +++ b/src/Service/CodeDeploy/src/ValueObject/EC2TagSet.php @@ -10,6 +10,8 @@ final class EC2TagSet /** * A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment * group, it must be identified by all of the tag groups in the list. + * + * @var EC2TagFilter[][]|null */ private $ec2TagSetList; diff --git a/src/Service/CodeDeploy/src/ValueObject/ELBInfo.php b/src/Service/CodeDeploy/src/ValueObject/ELBInfo.php index ca905037f..dd83865bc 100644 --- a/src/Service/CodeDeploy/src/ValueObject/ELBInfo.php +++ b/src/Service/CodeDeploy/src/ValueObject/ELBInfo.php @@ -13,6 +13,8 @@ final class ELBInfo * replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that * instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with * after the deployment is complete. + * + * @var string|null */ private $name; diff --git a/src/Service/CodeDeploy/src/ValueObject/ErrorInformation.php b/src/Service/CodeDeploy/src/ValueObject/ErrorInformation.php index 0977a3bba..eac56a656 100644 --- a/src/Service/CodeDeploy/src/ValueObject/ErrorInformation.php +++ b/src/Service/CodeDeploy/src/ValueObject/ErrorInformation.php @@ -36,11 +36,15 @@ final class ErrorInformation * * [^1]: https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html * [^2]: https://docs.aws.amazon.com/codedeploy/latest/userguide + * + * @var ErrorCode::*|null */ private $code; /** * An accompanying error message. + * + * @var string|null */ private $message; diff --git a/src/Service/CodeDeploy/src/ValueObject/GitHubLocation.php b/src/Service/CodeDeploy/src/ValueObject/GitHubLocation.php index 15a4da327..f7ff3b935 100644 --- a/src/Service/CodeDeploy/src/ValueObject/GitHubLocation.php +++ b/src/Service/CodeDeploy/src/ValueObject/GitHubLocation.php @@ -12,11 +12,15 @@ final class GitHubLocation * for the application revision. * * Specified as account/repository. + * + * @var string|null */ private $repository; /** * The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision. + * + * @var string|null */ private $commitId; diff --git a/src/Service/CodeDeploy/src/ValueObject/GreenFleetProvisioningOption.php b/src/Service/CodeDeploy/src/ValueObject/GreenFleetProvisioningOption.php index 99884a160..3984c0985 100644 --- a/src/Service/CodeDeploy/src/ValueObject/GreenFleetProvisioningOption.php +++ b/src/Service/CodeDeploy/src/ValueObject/GreenFleetProvisioningOption.php @@ -15,6 +15,8 @@ final class GreenFleetProvisioningOption * - `DISCOVER_EXISTING`: Use instances that already exist or will be created manually. * - `COPY_AUTO_SCALING_GROUP`: Use settings from a specified Auto Scaling group to define and create instances in a new * Auto Scaling group. + * + * @var GreenFleetProvisioningAction::*|null */ private $action; diff --git a/src/Service/CodeDeploy/src/ValueObject/LoadBalancerInfo.php b/src/Service/CodeDeploy/src/ValueObject/LoadBalancerInfo.php index c22bcd6b5..20e6c17f5 100644 --- a/src/Service/CodeDeploy/src/ValueObject/LoadBalancerInfo.php +++ b/src/Service/CodeDeploy/src/ValueObject/LoadBalancerInfo.php @@ -12,6 +12,8 @@ final class LoadBalancerInfo * Balancing, load balancers are used with Classic Load Balancers. * * > Adding more than one load balancer to the array is not supported. + * + * @var ELBInfo[]|null */ private $elbInfoList; @@ -20,11 +22,15 @@ final class LoadBalancerInfo * Balancing, target groups are used with Application Load Balancers. * * > Adding more than one target group to the array is not supported. + * + * @var TargetGroupInfo[]|null */ private $targetGroupInfoList; /** * The target group pair information. This is an array of `TargeGroupPairInfo` objects with a maximum size of one. + * + * @var TargetGroupPairInfo[]|null */ private $targetGroupPairInfoList; diff --git a/src/Service/CodeDeploy/src/ValueObject/RawString.php b/src/Service/CodeDeploy/src/ValueObject/RawString.php index 62b071c14..d3d1edf62 100644 --- a/src/Service/CodeDeploy/src/ValueObject/RawString.php +++ b/src/Service/CodeDeploy/src/ValueObject/RawString.php @@ -11,11 +11,15 @@ final class RawString /** * The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update * and optional Lambda functions that validate deployment lifecycle events. + * + * @var string|null */ private $content; /** * The SHA256 hash value of the revision content. + * + * @var string|null */ private $sha256; diff --git a/src/Service/CodeDeploy/src/ValueObject/RelatedDeployments.php b/src/Service/CodeDeploy/src/ValueObject/RelatedDeployments.php index 68a51ae8f..c817b58d2 100644 --- a/src/Service/CodeDeploy/src/ValueObject/RelatedDeployments.php +++ b/src/Service/CodeDeploy/src/ValueObject/RelatedDeployments.php @@ -9,11 +9,15 @@ final class RelatedDeployments { /** * The deployment ID of the root deployment that triggered this deployment. + * + * @var string|null */ private $autoUpdateOutdatedInstancesRootDeploymentId; /** * The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment. + * + * @var string[]|null */ private $autoUpdateOutdatedInstancesDeploymentIds; diff --git a/src/Service/CodeDeploy/src/ValueObject/RevisionLocation.php b/src/Service/CodeDeploy/src/ValueObject/RevisionLocation.php index 59772cd12..b37906b1f 100644 --- a/src/Service/CodeDeploy/src/ValueObject/RevisionLocation.php +++ b/src/Service/CodeDeploy/src/ValueObject/RevisionLocation.php @@ -18,27 +18,37 @@ final class RevisionLocation * - String: A YAML-formatted or JSON-formatted string (Lambda deployments only). * - AppSpecContent: An `AppSpecContent` object that contains the contents of an AppSpec file for an Lambda or Amazon * ECS deployment. The content is formatted as JSON or YAML stored as a RawString. + * + * @var RevisionLocationType::*|null */ private $revisionType; /** * Information about the location of a revision stored in Amazon S3. + * + * @var S3Location|null */ private $s3Location; /** * Information about the location of application artifacts stored in GitHub. + * + * @var GitHubLocation|null */ private $gitHubLocation; /** * Information about the location of an Lambda deployment revision stored as a RawString. + * + * @var RawString|null */ private $string; /** * The content of an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and * stored as a RawString. + * + * @var AppSpecContent|null */ private $appSpecContent; diff --git a/src/Service/CodeDeploy/src/ValueObject/RollbackInfo.php b/src/Service/CodeDeploy/src/ValueObject/RollbackInfo.php index ab37f4423..cd67681b7 100644 --- a/src/Service/CodeDeploy/src/ValueObject/RollbackInfo.php +++ b/src/Service/CodeDeploy/src/ValueObject/RollbackInfo.php @@ -9,18 +9,24 @@ final class RollbackInfo { /** * The ID of the deployment rollback. + * + * @var string|null */ private $rollbackDeploymentId; /** * The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was * stopped. + * + * @var string|null */ private $rollbackTriggeringDeploymentId; /** * Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled * back, is in progress, failed, or succeeded). + * + * @var string|null */ private $rollbackMessage; diff --git a/src/Service/CodeDeploy/src/ValueObject/S3Location.php b/src/Service/CodeDeploy/src/ValueObject/S3Location.php index c3a4b2d0c..49ba98256 100644 --- a/src/Service/CodeDeploy/src/ValueObject/S3Location.php +++ b/src/Service/CodeDeploy/src/ValueObject/S3Location.php @@ -12,11 +12,15 @@ final class S3Location { /** * The name of the Amazon S3 bucket where the application revision is stored. + * + * @var string|null */ private $bucket; /** * The name of the Amazon S3 object that represents the bundled artifacts for the application revision. + * + * @var string|null */ private $key; @@ -26,6 +30,8 @@ final class S3Location * - `tar`: A tar archive file. * - `tgz`: A compressed tar archive file. * - `zip`: A zip archive file. + * + * @var BundleType::*|null */ private $bundleType; @@ -33,6 +39,8 @@ final class S3Location * A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision. * * If the version is not specified, the system uses the most recent version by default. + * + * @var string|null */ private $version; @@ -40,6 +48,8 @@ final class S3Location * The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision. * * If the ETag is not specified as an input parameter, ETag validation of the object is skipped. + * + * @var string|null */ private $eTag; diff --git a/src/Service/CodeDeploy/src/ValueObject/TargetGroupInfo.php b/src/Service/CodeDeploy/src/ValueObject/TargetGroupInfo.php index ff7e1a317..77cee4558 100644 --- a/src/Service/CodeDeploy/src/ValueObject/TargetGroupInfo.php +++ b/src/Service/CodeDeploy/src/ValueObject/TargetGroupInfo.php @@ -13,6 +13,8 @@ final class TargetGroupInfo * from, and instances in the replacement environment are registered with. For in-place deployments, the name of the * target group that instances are deregistered from, so they are not serving traffic during a deployment, and then * re-registered with after the deployment is complete. + * + * @var string|null */ private $name; diff --git a/src/Service/CodeDeploy/src/ValueObject/TargetGroupPairInfo.php b/src/Service/CodeDeploy/src/ValueObject/TargetGroupPairInfo.php index d77bc0f98..22a086f2f 100644 --- a/src/Service/CodeDeploy/src/ValueObject/TargetGroupPairInfo.php +++ b/src/Service/CodeDeploy/src/ValueObject/TargetGroupPairInfo.php @@ -11,17 +11,23 @@ final class TargetGroupPairInfo /** * One pair of target groups. One is associated with the original task set. The second is associated with the task set * that serves traffic after the deployment is complete. + * + * @var TargetGroupInfo[]|null */ private $targetGroups; /** * The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete. + * + * @var TrafficRoute|null */ private $prodTrafficRoute; /** * An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur * while test traffic is served during a deployment. + * + * @var TrafficRoute|null */ private $testTrafficRoute; diff --git a/src/Service/CodeDeploy/src/ValueObject/TargetInstances.php b/src/Service/CodeDeploy/src/ValueObject/TargetInstances.php index 3778fa7bc..4fe8c346f 100644 --- a/src/Service/CodeDeploy/src/ValueObject/TargetInstances.php +++ b/src/Service/CodeDeploy/src/ValueObject/TargetInstances.php @@ -10,17 +10,23 @@ final class TargetInstances /** * The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a * blue/green deployment. Cannot be used in the same call as `ec2TagSet`. + * + * @var EC2TagFilter[]|null */ private $tagFilters; /** * The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment. + * + * @var string[]|null */ private $autoScalingGroups; /** * Information about the groups of Amazon EC2 instance tags that an instance must be identified by in order for it to be * included in the replacement environment for a blue/green deployment. Cannot be used in the same call as `tagFilters`. + * + * @var EC2TagSet|null */ private $ec2TagSet; diff --git a/src/Service/CodeDeploy/src/ValueObject/TrafficRoute.php b/src/Service/CodeDeploy/src/ValueObject/TrafficRoute.php index e4cae0f71..832a9b248 100644 --- a/src/Service/CodeDeploy/src/ValueObject/TrafficRoute.php +++ b/src/Service/CodeDeploy/src/ValueObject/TrafficRoute.php @@ -11,6 +11,8 @@ final class TrafficRoute /** * The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load * balancer. This is an array of strings with a maximum size of one. + * + * @var string[]|null */ private $listenerArns; diff --git a/src/Service/CognitoIdentityProvider/src/Result/AdminCreateUserResponse.php b/src/Service/CognitoIdentityProvider/src/Result/AdminCreateUserResponse.php index 7b5076771..e07079455 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/AdminCreateUserResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/AdminCreateUserResponse.php @@ -15,6 +15,8 @@ class AdminCreateUserResponse extends Result { /** * The newly created user. + * + * @var UserType|null */ private $user; diff --git a/src/Service/CognitoIdentityProvider/src/Result/AdminGetUserResponse.php b/src/Service/CognitoIdentityProvider/src/Result/AdminGetUserResponse.php index e6a13cf07..cb45b7dad 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/AdminGetUserResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/AdminGetUserResponse.php @@ -15,26 +15,36 @@ class AdminGetUserResponse extends Result { /** * The user name of the user about whom you're receiving information. + * + * @var string */ private $username; /** * An array of name-value pairs representing user attributes. + * + * @var AttributeType[] */ private $userAttributes; /** * The date the user was created. + * + * @var \DateTimeImmutable|null */ private $userCreateDate; /** * The date the user was last modified. + * + * @var \DateTimeImmutable|null */ private $userLastModifiedDate; /** * Indicates that the status is `enabled`. + * + * @var bool|null */ private $enabled; @@ -49,6 +59,8 @@ class AdminGetUserResponse extends Result * in. * - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first * sign-in, the user must change their password to a new value before doing anything else. + * + * @var UserStatusType::*|null */ private $userStatus; @@ -56,17 +68,23 @@ class AdminGetUserResponse extends Result * *This response parameter is no longer supported.* It provides information only about SMS MFA configurations. It * doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up * information about either type of MFA configuration, use UserMFASettingList instead. + * + * @var MFAOptionType[] */ private $mfaOptions; /** * The user's preferred MFA setting. + * + * @var string|null */ private $preferredMfaSetting; /** * The MFA options that are activated for the user. The possible values in this list are `SMS_MFA` and * `SOFTWARE_TOKEN_MFA`. + * + * @var string[] */ private $userMfaSettingList; diff --git a/src/Service/CognitoIdentityProvider/src/Result/AdminInitiateAuthResponse.php b/src/Service/CognitoIdentityProvider/src/Result/AdminInitiateAuthResponse.php index 6333bccc6..700985933 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/AdminInitiateAuthResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/AdminInitiateAuthResponse.php @@ -51,6 +51,8 @@ class AdminInitiateAuthResponse extends Result * sign-in. * * [^1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html + * + * @var ChallengeNameType::*|null */ private $challengeName; @@ -59,6 +61,8 @@ class AdminInitiateAuthResponse extends Result * `AdminRespondToAuthChallenge` API call determines that the caller must pass another challenge, they return a session * with other challenge parameters. This session should be passed as it is to the next `AdminRespondToAuthChallenge` API * call. + * + * @var string|null */ private $session; @@ -72,6 +76,8 @@ class AdminInitiateAuthResponse extends Result * The value of the `USER_ID_FOR_SRP` attribute is the user's actual username, not an alias (such as email address or * phone number), even if you specified an alias in your call to `AdminInitiateAuth`. This happens because, in the * `AdminRespondToAuthChallenge` API `ChallengeResponses`, the `USERNAME` attribute can't be an alias. + * + * @var array */ private $challengeParameters; @@ -79,6 +85,8 @@ class AdminInitiateAuthResponse extends Result * The result of the authentication response. This is only returned if the caller doesn't need to pass another * challenge. If the caller does need to pass another challenge before it gets tokens, `ChallengeName`, * `ChallengeParameters`, and `Session` are returned. + * + * @var AuthenticationResultType|null */ private $authenticationResult; diff --git a/src/Service/CognitoIdentityProvider/src/Result/AssociateSoftwareTokenResponse.php b/src/Service/CognitoIdentityProvider/src/Result/AssociateSoftwareTokenResponse.php index 6e893e92c..a777e22ff 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/AssociateSoftwareTokenResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/AssociateSoftwareTokenResponse.php @@ -9,12 +9,16 @@ class AssociateSoftwareTokenResponse extends Result { /** * A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code. + * + * @var string|null */ private $secretCode; /** * The session that should be passed both ways in challenge-response calls to the service. This allows authentication of * the user as part of the MFA setup process. + * + * @var string|null */ private $session; diff --git a/src/Service/CognitoIdentityProvider/src/Result/CreateGroupResponse.php b/src/Service/CognitoIdentityProvider/src/Result/CreateGroupResponse.php index 82e1253d1..7045a7cb2 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/CreateGroupResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/CreateGroupResponse.php @@ -10,6 +10,8 @@ class CreateGroupResponse extends Result { /** * The group object for the group. + * + * @var GroupType|null */ private $group; diff --git a/src/Service/CognitoIdentityProvider/src/Result/ForgotPasswordResponse.php b/src/Service/CognitoIdentityProvider/src/Result/ForgotPasswordResponse.php index 9f7663734..008e3fda2 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/ForgotPasswordResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/ForgotPasswordResponse.php @@ -13,6 +13,8 @@ class ForgotPasswordResponse extends Result { /** * The code delivery details returned by the server in response to the request to reset a password. + * + * @var CodeDeliveryDetailsType|null */ private $codeDeliveryDetails; diff --git a/src/Service/CognitoIdentityProvider/src/Result/GetUserResponse.php b/src/Service/CognitoIdentityProvider/src/Result/GetUserResponse.php index 248b31433..3eda6de15 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/GetUserResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/GetUserResponse.php @@ -14,6 +14,8 @@ class GetUserResponse extends Result { /** * The user name of the user you want to retrieve from the get user request. + * + * @var string */ private $username; @@ -21,6 +23,8 @@ class GetUserResponse extends Result * An array of name-value pairs representing user attributes. * * For custom attributes, you must prepend the `custom:` prefix to the attribute name. + * + * @var AttributeType[] */ private $userAttributes; @@ -28,17 +32,23 @@ class GetUserResponse extends Result * *This response parameter is no longer supported.* It provides information only about SMS MFA configurations. It * doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up * information about either type of MFA configuration, use UserMFASettingList instead. + * + * @var MFAOptionType[] */ private $mfaOptions; /** * The user's preferred MFA setting. + * + * @var string|null */ private $preferredMfaSetting; /** * The MFA options that are activated for the user. The possible values in this list are `SMS_MFA` and * `SOFTWARE_TOKEN_MFA`. + * + * @var string[] */ private $userMfaSettingList; diff --git a/src/Service/CognitoIdentityProvider/src/Result/InitiateAuthResponse.php b/src/Service/CognitoIdentityProvider/src/Result/InitiateAuthResponse.php index 7cc3956a2..f3fc6c86c 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/InitiateAuthResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/InitiateAuthResponse.php @@ -48,6 +48,8 @@ class InitiateAuthResponse extends Result * add a phone number to their account, and then the user should call `InitiateAuth` again to restart sign-in. * * [^1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html + * + * @var ChallengeNameType::*|null */ private $challengeName; @@ -55,6 +57,8 @@ class InitiateAuthResponse extends Result * The session that should pass both ways in challenge-response calls to the service. If the caller must pass another * challenge, they return a session with other challenge parameters. This session should be passed as it is to the next * `RespondToAuthChallenge` API call. + * + * @var string|null */ private $session; @@ -63,6 +67,8 @@ class InitiateAuthResponse extends Result * responses in this parameter should be used to compute inputs to the next call (`RespondToAuthChallenge`). * * All challenges require `USERNAME` and `SECRET_HASH` (if applicable). + * + * @var array */ private $challengeParameters; @@ -70,6 +76,8 @@ class InitiateAuthResponse extends Result * The result of the authentication response. This result is only returned if the caller doesn't need to pass another * challenge. If the caller does need to pass another challenge before it gets tokens, `ChallengeName`, * `ChallengeParameters`, and `Session` are returned. + * + * @var AuthenticationResultType|null */ private $authenticationResult; diff --git a/src/Service/CognitoIdentityProvider/src/Result/ListGroupsResponse.php b/src/Service/CognitoIdentityProvider/src/Result/ListGroupsResponse.php index bb1400998..399da8bc4 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/ListGroupsResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/ListGroupsResponse.php @@ -16,12 +16,16 @@ class ListGroupsResponse extends Result implements \IteratorAggregate { /** * The group objects for the groups. + * + * @var GroupType[] */ private $groups; /** * An identifier that was returned from the previous call to this operation, which can be used to return the next set of * items in the list. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/CognitoIdentityProvider/src/Result/ListUsersResponse.php b/src/Service/CognitoIdentityProvider/src/Result/ListUsersResponse.php index d8c422f3b..3c43ad584 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/ListUsersResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/ListUsersResponse.php @@ -20,12 +20,16 @@ class ListUsersResponse extends Result implements \IteratorAggregate { /** * The users returned in the request to list users. + * + * @var UserType[] */ private $users; /** * An identifier that was returned from the previous call to this operation, which can be used to return the next set of * items in the list. + * + * @var string|null */ private $paginationToken; diff --git a/src/Service/CognitoIdentityProvider/src/Result/ResendConfirmationCodeResponse.php b/src/Service/CognitoIdentityProvider/src/Result/ResendConfirmationCodeResponse.php index c060f25cf..19feecc0b 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/ResendConfirmationCodeResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/ResendConfirmationCodeResponse.php @@ -13,6 +13,8 @@ class ResendConfirmationCodeResponse extends Result { /** * The code delivery details returned by the server in response to the request to resend the confirmation code. + * + * @var CodeDeliveryDetailsType|null */ private $codeDeliveryDetails; diff --git a/src/Service/CognitoIdentityProvider/src/Result/RespondToAuthChallengeResponse.php b/src/Service/CognitoIdentityProvider/src/Result/RespondToAuthChallengeResponse.php index da0007a0b..bad42e4c6 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/RespondToAuthChallengeResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/RespondToAuthChallengeResponse.php @@ -17,6 +17,8 @@ class RespondToAuthChallengeResponse extends Result * The challenge name. For more information, see InitiateAuth [^1]. * * [^1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html + * + * @var ChallengeNameType::*|null */ private $challengeName; @@ -24,6 +26,8 @@ class RespondToAuthChallengeResponse extends Result * The session that should be passed both ways in challenge-response calls to the service. If the caller must pass * another challenge, they return a session with other challenge parameters. This session should be passed as it is to * the next `RespondToAuthChallenge` API call. + * + * @var string|null */ private $session; @@ -31,11 +35,15 @@ class RespondToAuthChallengeResponse extends Result * The challenge parameters. For more information, see InitiateAuth [^1]. * * [^1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html + * + * @var array */ private $challengeParameters; /** * The result returned by the server in response to the request to respond to the authentication challenge. + * + * @var AuthenticationResultType|null */ private $authenticationResult; diff --git a/src/Service/CognitoIdentityProvider/src/Result/SignUpResponse.php b/src/Service/CognitoIdentityProvider/src/Result/SignUpResponse.php index 182c93d24..cb72944de 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/SignUpResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/SignUpResponse.php @@ -13,16 +13,22 @@ class SignUpResponse extends Result { /** * A response from the server indicating that a user registration has been confirmed. + * + * @var bool */ private $userConfirmed; /** * The code delivery details returned by the server response to the user registration request. + * + * @var CodeDeliveryDetailsType|null */ private $codeDeliveryDetails; /** * The UUID of the authenticated user. This isn't the same as `username`. + * + * @var string */ private $userSub; diff --git a/src/Service/CognitoIdentityProvider/src/Result/VerifySoftwareTokenResponse.php b/src/Service/CognitoIdentityProvider/src/Result/VerifySoftwareTokenResponse.php index 800db4103..6d699f506 100644 --- a/src/Service/CognitoIdentityProvider/src/Result/VerifySoftwareTokenResponse.php +++ b/src/Service/CognitoIdentityProvider/src/Result/VerifySoftwareTokenResponse.php @@ -10,11 +10,15 @@ class VerifySoftwareTokenResponse extends Result { /** * The status of the verify software token. + * + * @var VerifySoftwareTokenResponseType::*|null */ private $status; /** * The session that should be passed both ways in challenge-response calls to the service. + * + * @var string|null */ private $session; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/AnalyticsMetadataType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/AnalyticsMetadataType.php index 5361e7f38..bc12aa352 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/AnalyticsMetadataType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/AnalyticsMetadataType.php @@ -15,6 +15,8 @@ final class AnalyticsMetadataType { /** * The endpoint ID. + * + * @var string|null */ private $analyticsEndpointId; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/AttributeType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/AttributeType.php index beb7d6dc0..633f175e0 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/AttributeType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/AttributeType.php @@ -11,11 +11,15 @@ final class AttributeType { /** * The name of the attribute. + * + * @var string */ private $name; /** * The value of the attribute. + * + * @var string|null */ private $value; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/AuthenticationResultType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/AuthenticationResultType.php index 59b313082..849729e68 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/AuthenticationResultType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/AuthenticationResultType.php @@ -9,31 +9,43 @@ final class AuthenticationResultType { /** * A valid access token that Amazon Cognito issued to the user who you want to authenticate. + * + * @var string|null */ private $accessToken; /** * The expiration period of the authentication result in seconds. + * + * @var int|null */ private $expiresIn; /** * The token type. + * + * @var string|null */ private $tokenType; /** * The refresh token. + * + * @var string|null */ private $refreshToken; /** * The ID token. + * + * @var string|null */ private $idToken; /** * The new device metadata from an authentication result. + * + * @var NewDeviceMetadataType|null */ private $newDeviceMetadata; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/CodeDeliveryDetailsType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/CodeDeliveryDetailsType.php index cfa63380e..6e096679f 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/CodeDeliveryDetailsType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/CodeDeliveryDetailsType.php @@ -11,16 +11,22 @@ final class CodeDeliveryDetailsType { /** * The email address or phone number destination where Amazon Cognito sent the code. + * + * @var string|null */ private $destination; /** * The method that Amazon Cognito used to send the code. + * + * @var DeliveryMediumType::*|null */ private $deliveryMedium; /** * The name of the attribute that Amazon Cognito verifies with the code. + * + * @var string|null */ private $attributeName; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/ContextDataType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/ContextDataType.php index b2fa37608..26646ff50 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/ContextDataType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/ContextDataType.php @@ -11,21 +11,29 @@ final class ContextDataType { /** * The source IP address of your user's device. + * + * @var string */ private $ipAddress; /** * Your server endpoint where this API is invoked. + * + * @var string */ private $serverName; /** * Your server path where this API is invoked. + * + * @var string */ private $serverPath; /** * HttpHeaders received on your server in same order. + * + * @var HttpHeader[] */ private $httpHeaders; @@ -34,6 +42,8 @@ final class ContextDataType * For more information, see Adding user device and session data to API requests [^1]. * * [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint + * + * @var string|null */ private $encodedData; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/GroupType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/GroupType.php index 4210e4baa..5fc1629d4 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/GroupType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/GroupType.php @@ -9,21 +9,29 @@ final class GroupType { /** * The name of the group. + * + * @var string|null */ private $groupName; /** * The user pool ID for the user pool. + * + * @var string|null */ private $userPoolId; /** * A string containing the description of the group. + * + * @var string|null */ private $description; /** * The role Amazon Resource Name (ARN) for the group. + * + * @var string|null */ private $roleArn; @@ -40,16 +48,22 @@ final class GroupType * isn't set in users' tokens. * * The default `Precedence` value is null. + * + * @var int|null */ private $precedence; /** * The date the group was last modified. + * + * @var \DateTimeImmutable|null */ private $lastModifiedDate; /** * The date the group was created. + * + * @var \DateTimeImmutable|null */ private $creationDate; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/HttpHeader.php b/src/Service/CognitoIdentityProvider/src/ValueObject/HttpHeader.php index 57d4bef12..08634aa65 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/HttpHeader.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/HttpHeader.php @@ -9,11 +9,15 @@ final class HttpHeader { /** * The header name. + * + * @var string|null */ private $headerName; /** * The header value. + * + * @var string|null */ private $headerValue; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/MFAOptionType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/MFAOptionType.php index 7a5decd8d..4813cb3b0 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/MFAOptionType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/MFAOptionType.php @@ -12,11 +12,15 @@ final class MFAOptionType { /** * The delivery medium to send the MFA code. You can use this parameter to set only the `SMS` delivery medium value. + * + * @var DeliveryMediumType::*|null */ private $deliveryMedium; /** * The attribute name of the MFA option type. The only valid value is `phone_number`. + * + * @var string|null */ private $attributeName; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/NewDeviceMetadataType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/NewDeviceMetadataType.php index 9f0adc13b..a83db7abe 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/NewDeviceMetadataType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/NewDeviceMetadataType.php @@ -9,11 +9,15 @@ final class NewDeviceMetadataType { /** * The device key. + * + * @var string|null */ private $deviceKey; /** * The device group key. + * + * @var string|null */ private $deviceGroupKey; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/SMSMfaSettingsType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/SMSMfaSettingsType.php index 9a8cd1b1a..13204a25f 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/SMSMfaSettingsType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/SMSMfaSettingsType.php @@ -14,11 +14,15 @@ final class SMSMfaSettingsType /** * Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be * prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. + * + * @var bool|null */ private $enabled; /** * Specifies whether SMS is the preferred MFA method. + * + * @var bool|null */ private $preferredMfa; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/SoftwareTokenMfaSettingsType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/SoftwareTokenMfaSettingsType.php index 009fc95ce..e28c87d9b 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/SoftwareTokenMfaSettingsType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/SoftwareTokenMfaSettingsType.php @@ -13,11 +13,15 @@ final class SoftwareTokenMfaSettingsType /** * Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted * for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. + * + * @var bool|null */ private $enabled; /** * Specifies whether software token MFA is the preferred MFA method. + * + * @var bool|null */ private $preferredMfa; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/UserContextDataType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/UserContextDataType.php index 3c7c3bbce..061b73e4b 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/UserContextDataType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/UserContextDataType.php @@ -10,6 +10,8 @@ final class UserContextDataType { /** * The source IP address of your user's device. + * + * @var string|null */ private $ipAddress; @@ -18,6 +20,8 @@ final class UserContextDataType * For more information, see Adding user device and session data to API requests [^1]. * * [^1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint + * + * @var string|null */ private $encodedData; diff --git a/src/Service/CognitoIdentityProvider/src/ValueObject/UserType.php b/src/Service/CognitoIdentityProvider/src/ValueObject/UserType.php index 42e0a53f1..3901563d6 100644 --- a/src/Service/CognitoIdentityProvider/src/ValueObject/UserType.php +++ b/src/Service/CognitoIdentityProvider/src/ValueObject/UserType.php @@ -11,26 +11,36 @@ final class UserType { /** * The user name of the user you want to describe. + * + * @var string|null */ private $username; /** * A container with information about the user type attributes. + * + * @var AttributeType[]|null */ private $attributes; /** * The creation date of the user. + * + * @var \DateTimeImmutable|null */ private $userCreateDate; /** * The last modified date of the user. + * + * @var \DateTimeImmutable|null */ private $userLastModifiedDate; /** * Specifies whether the user is enabled. + * + * @var bool|null */ private $enabled; @@ -46,11 +56,15 @@ final class UserType * in. * - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first * sign-in, the user must change their password to a new value before doing anything else. + * + * @var UserStatusType::*|null */ private $userStatus; /** * The MFA options for the user. + * + * @var MFAOptionType[]|null */ private $mfaOptions; diff --git a/src/Service/Comprehend/src/Exception/InvalidRequestException.php b/src/Service/Comprehend/src/Exception/InvalidRequestException.php index c4e97ca44..c0d0e9729 100644 --- a/src/Service/Comprehend/src/Exception/InvalidRequestException.php +++ b/src/Service/Comprehend/src/Exception/InvalidRequestException.php @@ -12,8 +12,14 @@ */ final class InvalidRequestException extends ClientException { + /** + * @var InvalidRequestReason::*|null + */ private $reason; + /** + * @var InvalidRequestDetail|null + */ private $detail; public function getDetail(): ?InvalidRequestDetail diff --git a/src/Service/Comprehend/src/Result/DetectDominantLanguageResponse.php b/src/Service/Comprehend/src/Result/DetectDominantLanguageResponse.php index bf424ef8d..78e8c8833 100644 --- a/src/Service/Comprehend/src/Result/DetectDominantLanguageResponse.php +++ b/src/Service/Comprehend/src/Result/DetectDominantLanguageResponse.php @@ -17,6 +17,8 @@ class DetectDominantLanguageResponse extends Result * the *IETF Tools* web site. * * [^1]: https://tools.ietf.org/html/rfc5646 + * + * @var DominantLanguage[] */ private $languages; diff --git a/src/Service/Comprehend/src/ValueObject/DominantLanguage.php b/src/Service/Comprehend/src/ValueObject/DominantLanguage.php index 66878336e..69e23dbdf 100644 --- a/src/Service/Comprehend/src/ValueObject/DominantLanguage.php +++ b/src/Service/Comprehend/src/ValueObject/DominantLanguage.php @@ -13,11 +13,15 @@ final class DominantLanguage * Languages [^1] on the *IETF Tools* web site. * * [^1]: https://tools.ietf.org/html/rfc5646 + * + * @var string|null */ private $languageCode; /** * The level of confidence that Amazon Comprehend has in the accuracy of the detection. + * + * @var float|null */ private $score; diff --git a/src/Service/Comprehend/src/ValueObject/InvalidRequestDetail.php b/src/Service/Comprehend/src/ValueObject/InvalidRequestDetail.php index baa914136..02420a11e 100644 --- a/src/Service/Comprehend/src/ValueObject/InvalidRequestDetail.php +++ b/src/Service/Comprehend/src/ValueObject/InvalidRequestDetail.php @@ -17,6 +17,8 @@ final class InvalidRequestDetail { /** * Reason code is `INVALID_DOCUMENT`. + * + * @var InvalidRequestDetailReason::*|null */ private $reason; diff --git a/src/Service/DynamoDb/src/Exception/TransactionCanceledException.php b/src/Service/DynamoDb/src/Exception/TransactionCanceledException.php index b63a4b4d1..01818d09e 100644 --- a/src/Service/DynamoDb/src/Exception/TransactionCanceledException.php +++ b/src/Service/DynamoDb/src/Exception/TransactionCanceledException.php @@ -113,6 +113,8 @@ final class TransactionCanceledException extends ClientException { /** * A list of cancellation reasons. + * + * @var CancellationReason[] */ private $cancellationReasons; diff --git a/src/Service/DynamoDb/src/Result/BatchGetItemOutput.php b/src/Service/DynamoDb/src/Result/BatchGetItemOutput.php index ac7e7f8c2..b3096edc2 100644 --- a/src/Service/DynamoDb/src/Result/BatchGetItemOutput.php +++ b/src/Service/DynamoDb/src/Result/BatchGetItemOutput.php @@ -22,6 +22,8 @@ class BatchGetItemOutput extends Result implements \IteratorAggregate /** * A map of table name to a list of items. Each object in `Responses` consists of a table name, along with a map of * attribute data consisting of the data type and attribute value. + * + * @var array[]> */ private $responses; @@ -39,6 +41,8 @@ class BatchGetItemOutput extends Result implements \IteratorAggregate * otherwise, an eventually consistent read is used. * * If there are no unprocessed keys remaining, the response contains an empty `UnprocessedKeys` map. + * + * @var array */ private $unprocessedKeys; @@ -49,6 +53,8 @@ class BatchGetItemOutput extends Result implements \IteratorAggregate * * - `TableName` - The table that consumed the provisioned throughput. * - `CapacityUnits` - The total number of capacity units consumed. + * + * @var ConsumedCapacity[] */ private $consumedCapacity; diff --git a/src/Service/DynamoDb/src/Result/BatchWriteItemOutput.php b/src/Service/DynamoDb/src/Result/BatchWriteItemOutput.php index 0ac295c31..966ecbfb3 100644 --- a/src/Service/DynamoDb/src/Result/BatchWriteItemOutput.php +++ b/src/Service/DynamoDb/src/Result/BatchWriteItemOutput.php @@ -44,6 +44,8 @@ class BatchWriteItemOutput extends Result * * * If there are no unprocessed items remaining, the response contains an empty `UnprocessedItems` map. + * + * @var array */ private $unprocessedItems; @@ -61,6 +63,8 @@ class BatchWriteItemOutput extends Result * estimate to measure whether a local secondary index is approaching its size limit. * * The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + * + * @var array */ private $itemCollectionMetrics; @@ -71,6 +75,8 @@ class BatchWriteItemOutput extends Result * * - `TableName` - The table that consumed the provisioned throughput. * - `CapacityUnits` - The total number of capacity units consumed. + * + * @var ConsumedCapacity[] */ private $consumedCapacity; diff --git a/src/Service/DynamoDb/src/Result/CreateTableOutput.php b/src/Service/DynamoDb/src/Result/CreateTableOutput.php index 566fc4190..1f6500064 100644 --- a/src/Service/DynamoDb/src/Result/CreateTableOutput.php +++ b/src/Service/DynamoDb/src/Result/CreateTableOutput.php @@ -28,6 +28,8 @@ class CreateTableOutput extends Result { /** * Represents the properties of the table. + * + * @var TableDescription|null */ private $tableDescription; diff --git a/src/Service/DynamoDb/src/Result/DeleteItemOutput.php b/src/Service/DynamoDb/src/Result/DeleteItemOutput.php index 30f4c86ad..ade6133ce 100644 --- a/src/Service/DynamoDb/src/Result/DeleteItemOutput.php +++ b/src/Service/DynamoDb/src/Result/DeleteItemOutput.php @@ -17,6 +17,8 @@ class DeleteItemOutput extends Result /** * A map of attribute names to `AttributeValue` objects, representing the item as it appeared before the `DeleteItem` * operation. This map appears in the response only if `ReturnValues` was specified as `ALL_OLD` in the request. + * + * @var array */ private $attributes; @@ -27,6 +29,8 @@ class DeleteItemOutput extends Result * see Provisioned Throughput [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html + * + * @var ConsumedCapacity|null */ private $consumedCapacity; @@ -45,6 +49,8 @@ class DeleteItemOutput extends Result * this estimate to measure whether a local secondary index is approaching its size limit. * * The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + * + * @var ItemCollectionMetrics|null */ private $itemCollectionMetrics; diff --git a/src/Service/DynamoDb/src/Result/DeleteTableOutput.php b/src/Service/DynamoDb/src/Result/DeleteTableOutput.php index 659800ad7..b22d357e9 100644 --- a/src/Service/DynamoDb/src/Result/DeleteTableOutput.php +++ b/src/Service/DynamoDb/src/Result/DeleteTableOutput.php @@ -28,6 +28,8 @@ class DeleteTableOutput extends Result { /** * Represents the properties of a table. + * + * @var TableDescription|null */ private $tableDescription; diff --git a/src/Service/DynamoDb/src/Result/DescribeEndpointsResponse.php b/src/Service/DynamoDb/src/Result/DescribeEndpointsResponse.php index bd645fae7..c14f8b0bb 100644 --- a/src/Service/DynamoDb/src/Result/DescribeEndpointsResponse.php +++ b/src/Service/DynamoDb/src/Result/DescribeEndpointsResponse.php @@ -10,6 +10,8 @@ class DescribeEndpointsResponse extends Result { /** * List of endpoints. + * + * @var Endpoint[] */ private $endpoints; diff --git a/src/Service/DynamoDb/src/Result/DescribeTableOutput.php b/src/Service/DynamoDb/src/Result/DescribeTableOutput.php index 9d7d925fe..8a33617df 100644 --- a/src/Service/DynamoDb/src/Result/DescribeTableOutput.php +++ b/src/Service/DynamoDb/src/Result/DescribeTableOutput.php @@ -28,6 +28,8 @@ class DescribeTableOutput extends Result { /** * The properties of the table. + * + * @var TableDescription|null */ private $table; diff --git a/src/Service/DynamoDb/src/Result/ExecuteStatementOutput.php b/src/Service/DynamoDb/src/Result/ExecuteStatementOutput.php index 5ceae6eb1..21b57913b 100644 --- a/src/Service/DynamoDb/src/Result/ExecuteStatementOutput.php +++ b/src/Service/DynamoDb/src/Result/ExecuteStatementOutput.php @@ -13,15 +13,22 @@ class ExecuteStatementOutput extends Result /** * If a read operation was used, this property will contain the result of the read operation; a map of attribute names * and their values. For the write operations this value will be empty. + * + * @var array[] */ private $items; /** * If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If * set, you can use that this value in the subsequent request to get the remaining results. + * + * @var string|null */ private $nextToken; + /** + * @var ConsumedCapacity|null + */ private $consumedCapacity; /** @@ -30,6 +37,8 @@ class ExecuteStatementOutput extends Result * of results has been processed and there is no more data to be retrieved. If `LastEvaluatedKey` is not empty, it does * not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of * the result set is when `LastEvaluatedKey` is empty. + * + * @var array */ private $lastEvaluatedKey; diff --git a/src/Service/DynamoDb/src/Result/GetItemOutput.php b/src/Service/DynamoDb/src/Result/GetItemOutput.php index ff3abdea8..429d5e382 100644 --- a/src/Service/DynamoDb/src/Result/GetItemOutput.php +++ b/src/Service/DynamoDb/src/Result/GetItemOutput.php @@ -15,6 +15,8 @@ class GetItemOutput extends Result { /** * A map of attribute names to `AttributeValue` objects, as specified by `ProjectionExpression`. + * + * @var array */ private $item; @@ -25,6 +27,8 @@ class GetItemOutput extends Result * [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads + * + * @var ConsumedCapacity|null */ private $consumedCapacity; diff --git a/src/Service/DynamoDb/src/Result/ListTablesOutput.php b/src/Service/DynamoDb/src/Result/ListTablesOutput.php index 24f5348b9..674afb48d 100644 --- a/src/Service/DynamoDb/src/Result/ListTablesOutput.php +++ b/src/Service/DynamoDb/src/Result/ListTablesOutput.php @@ -21,6 +21,8 @@ class ListTablesOutput extends Result implements \IteratorAggregate * * If `LastEvaluatedTableName` also appears in the output, you can use this value as the `ExclusiveStartTableName` * parameter in a subsequent `ListTables` request and obtain the next page of results. + * + * @var string[] */ private $tableNames; @@ -30,6 +32,8 @@ class ListTablesOutput extends Result implements \IteratorAggregate * * If you do not receive a `LastEvaluatedTableName` value in the response, this means that there are no more table names * to be retrieved. + * + * @var string|null */ private $lastEvaluatedTableName; diff --git a/src/Service/DynamoDb/src/Result/PutItemOutput.php b/src/Service/DynamoDb/src/Result/PutItemOutput.php index bee6f6c34..818785cc2 100644 --- a/src/Service/DynamoDb/src/Result/PutItemOutput.php +++ b/src/Service/DynamoDb/src/Result/PutItemOutput.php @@ -17,6 +17,8 @@ class PutItemOutput extends Result /** * The attribute values as they appeared before the `PutItem` operation, but only if `ReturnValues` is specified as * `ALL_OLD` in the request. Each element consists of an attribute name and an attribute value. + * + * @var array */ private $attributes; @@ -27,6 +29,8 @@ class PutItemOutput extends Result * [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html + * + * @var ConsumedCapacity|null */ private $consumedCapacity; @@ -45,6 +49,8 @@ class PutItemOutput extends Result * this estimate to measure whether a local secondary index is approaching its size limit. * * The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + * + * @var ItemCollectionMetrics|null */ private $itemCollectionMetrics; diff --git a/src/Service/DynamoDb/src/Result/QueryOutput.php b/src/Service/DynamoDb/src/Result/QueryOutput.php index 9af3d9434..dec0ac0af 100644 --- a/src/Service/DynamoDb/src/Result/QueryOutput.php +++ b/src/Service/DynamoDb/src/Result/QueryOutput.php @@ -21,6 +21,8 @@ class QueryOutput extends Result implements \IteratorAggregate /** * An array of item attributes that match the query criteria. Each element in this array consists of an attribute name * and the value for that attribute. + * + * @var array[] */ private $items; @@ -31,6 +33,8 @@ class QueryOutput extends Result implements \IteratorAggregate * applied, and `ScannedCount` is the number of matching items before the filter was applied. * * If you did not use a filter in the request, then `Count` and `ScannedCount` are the same. + * + * @var int|null */ private $count; @@ -42,6 +46,8 @@ class QueryOutput extends Result implements \IteratorAggregate * If you did not use a filter in the request, then `ScannedCount` is the same as `Count`. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count + * + * @var int|null */ private $scannedCount; @@ -54,6 +60,8 @@ class QueryOutput extends Result implements \IteratorAggregate * * If `LastEvaluatedKey` is not empty, it does not necessarily mean that there is more data in the result set. The only * way to know when you have reached the end of the result set is when `LastEvaluatedKey` is empty. + * + * @var array */ private $lastEvaluatedKey; @@ -64,6 +72,8 @@ class QueryOutput extends Result implements \IteratorAggregate * [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html + * + * @var ConsumedCapacity|null */ private $consumedCapacity; diff --git a/src/Service/DynamoDb/src/Result/ScanOutput.php b/src/Service/DynamoDb/src/Result/ScanOutput.php index 07944b19c..fa2f46b43 100644 --- a/src/Service/DynamoDb/src/Result/ScanOutput.php +++ b/src/Service/DynamoDb/src/Result/ScanOutput.php @@ -21,6 +21,8 @@ class ScanOutput extends Result implements \IteratorAggregate /** * An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name * and the value for that attribute. + * + * @var array[] */ private $items; @@ -31,6 +33,8 @@ class ScanOutput extends Result implements \IteratorAggregate * and `ScannedCount` is the number of matching items before the filter was applied. * * If you did not use a filter in the request, then `Count` is the same as `ScannedCount`. + * + * @var int|null */ private $count; @@ -42,6 +46,8 @@ class ScanOutput extends Result implements \IteratorAggregate * If you did not use a filter in the request, then `ScannedCount` is the same as `Count`. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count + * + * @var int|null */ private $scannedCount; @@ -54,6 +60,8 @@ class ScanOutput extends Result implements \IteratorAggregate * * If `LastEvaluatedKey` is not empty, it does not necessarily mean that there is more data in the result set. The only * way to know when you have reached the end of the result set is when `LastEvaluatedKey` is empty. + * + * @var array */ private $lastEvaluatedKey; @@ -64,6 +72,8 @@ class ScanOutput extends Result implements \IteratorAggregate * [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads + * + * @var ConsumedCapacity|null */ private $consumedCapacity; diff --git a/src/Service/DynamoDb/src/Result/TransactWriteItemsOutput.php b/src/Service/DynamoDb/src/Result/TransactWriteItemsOutput.php index a488f6997..34e4e7c37 100644 --- a/src/Service/DynamoDb/src/Result/TransactWriteItemsOutput.php +++ b/src/Service/DynamoDb/src/Result/TransactWriteItemsOutput.php @@ -14,12 +14,16 @@ class TransactWriteItemsOutput extends Result /** * The capacity units consumed by the entire `TransactWriteItems` operation. The values of the list are ordered * according to the ordering of the `TransactItems` request parameter. + * + * @var ConsumedCapacity[] */ private $consumedCapacity; /** * A list of tables that were processed by `TransactWriteItems` and, for each table, information about any item * collections that were affected by individual `UpdateItem`, `PutItem`, or `DeleteItem` operations. + * + * @var array */ private $itemCollectionMetrics; diff --git a/src/Service/DynamoDb/src/Result/UpdateItemOutput.php b/src/Service/DynamoDb/src/Result/UpdateItemOutput.php index db0b181a6..e27e3219f 100644 --- a/src/Service/DynamoDb/src/Result/UpdateItemOutput.php +++ b/src/Service/DynamoDb/src/Result/UpdateItemOutput.php @@ -20,6 +20,8 @@ class UpdateItemOutput extends Result * * The `Attributes` map is only present if the update was successful and `ReturnValues` was specified as something other * than `NONE` in the request. Each element represents one attribute. + * + * @var array */ private $attributes; @@ -30,6 +32,8 @@ class UpdateItemOutput extends Result * see Provisioned Throughput [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads + * + * @var ConsumedCapacity|null */ private $consumedCapacity; @@ -48,6 +52,8 @@ class UpdateItemOutput extends Result * this estimate to measure whether a local secondary index is approaching its size limit. * * The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + * + * @var ItemCollectionMetrics|null */ private $itemCollectionMetrics; diff --git a/src/Service/DynamoDb/src/Result/UpdateTableOutput.php b/src/Service/DynamoDb/src/Result/UpdateTableOutput.php index 8a079579a..f903c845d 100644 --- a/src/Service/DynamoDb/src/Result/UpdateTableOutput.php +++ b/src/Service/DynamoDb/src/Result/UpdateTableOutput.php @@ -28,6 +28,8 @@ class UpdateTableOutput extends Result { /** * Represents the properties of the table. + * + * @var TableDescription|null */ private $tableDescription; diff --git a/src/Service/DynamoDb/src/Result/UpdateTimeToLiveOutput.php b/src/Service/DynamoDb/src/Result/UpdateTimeToLiveOutput.php index f4658543c..5a59a93b6 100644 --- a/src/Service/DynamoDb/src/Result/UpdateTimeToLiveOutput.php +++ b/src/Service/DynamoDb/src/Result/UpdateTimeToLiveOutput.php @@ -10,6 +10,8 @@ class UpdateTimeToLiveOutput extends Result { /** * Represents the output of an `UpdateTimeToLive` operation. + * + * @var TimeToLiveSpecification|null */ private $timeToLiveSpecification; diff --git a/src/Service/DynamoDb/src/ValueObject/ArchivalSummary.php b/src/Service/DynamoDb/src/ValueObject/ArchivalSummary.php index e48fcdaea..0dcb957ef 100644 --- a/src/Service/DynamoDb/src/ValueObject/ArchivalSummary.php +++ b/src/Service/DynamoDb/src/ValueObject/ArchivalSummary.php @@ -9,6 +9,8 @@ final class ArchivalSummary { /** * The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format. + * + * @var \DateTimeImmutable|null */ private $archivalDateTime; @@ -17,12 +19,16 @@ final class ArchivalSummary * * - `INACCESSIBLE_ENCRYPTION_CREDENTIALS` - The table was archived due to the table's KMS key being inaccessible for * more than seven days. An On-Demand backup was created at the archival time. + * + * @var string|null */ private $archivalReason; /** * The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If * you wish to restore this backup to the same table name, you will need to delete the original table. + * + * @var string|null */ private $archivalBackupArn; diff --git a/src/Service/DynamoDb/src/ValueObject/AttributeDefinition.php b/src/Service/DynamoDb/src/ValueObject/AttributeDefinition.php index fe532378e..2b09f5557 100644 --- a/src/Service/DynamoDb/src/ValueObject/AttributeDefinition.php +++ b/src/Service/DynamoDb/src/ValueObject/AttributeDefinition.php @@ -12,6 +12,8 @@ final class AttributeDefinition { /** * A name for the attribute. + * + * @var string */ private $attributeName; @@ -21,6 +23,8 @@ final class AttributeDefinition * - `S` - the attribute is of type String * - `N` - the attribute is of type Number * - `B` - the attribute is of type Binary + * + * @var ScalarAttributeType::* */ private $attributeType; diff --git a/src/Service/DynamoDb/src/ValueObject/AttributeValue.php b/src/Service/DynamoDb/src/ValueObject/AttributeValue.php index 6123908f3..54af46600 100644 --- a/src/Service/DynamoDb/src/ValueObject/AttributeValue.php +++ b/src/Service/DynamoDb/src/ValueObject/AttributeValue.php @@ -17,6 +17,8 @@ final class AttributeValue * An attribute of type String. For example:. * * `"S": "Hello"` + * + * @var string|null */ private $s; @@ -27,6 +29,8 @@ final class AttributeValue * * Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. * However, DynamoDB treats them as number type attributes for mathematical operations. + * + * @var string|null */ private $n; @@ -34,6 +38,8 @@ final class AttributeValue * An attribute of type Binary. For example:. * * `"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"` + * + * @var string|null */ private $b; @@ -41,6 +47,8 @@ final class AttributeValue * An attribute of type String Set. For example:. * * `"SS": ["Giraffe", "Hippo" ,"Zebra"]` + * + * @var string[]|null */ private $ss; @@ -51,6 +59,8 @@ final class AttributeValue * * Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. * However, DynamoDB treats them as number type attributes for mathematical operations. + * + * @var string[]|null */ private $ns; @@ -58,6 +68,8 @@ final class AttributeValue * An attribute of type Binary Set. For example:. * * `"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]` + * + * @var string[]|null */ private $bs; @@ -65,6 +77,8 @@ final class AttributeValue * An attribute of type Map. For example:. * * `"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}` + * + * @var array|null */ private $m; @@ -72,6 +86,8 @@ final class AttributeValue * An attribute of type List. For example:. * * `"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]` + * + * @var AttributeValue[]|null */ private $l; @@ -79,6 +95,8 @@ final class AttributeValue * An attribute of type Null. For example:. * * `"NULL": true` + * + * @var bool|null */ private $null; @@ -86,6 +104,8 @@ final class AttributeValue * An attribute of type Boolean. For example:. * * `"BOOL": true` + * + * @var bool|null */ private $bool; diff --git a/src/Service/DynamoDb/src/ValueObject/AttributeValueUpdate.php b/src/Service/DynamoDb/src/ValueObject/AttributeValueUpdate.php index 1a26f4b91..1eb501c2d 100644 --- a/src/Service/DynamoDb/src/ValueObject/AttributeValueUpdate.php +++ b/src/Service/DynamoDb/src/ValueObject/AttributeValueUpdate.php @@ -25,6 +25,8 @@ final class AttributeValueUpdate * For more information, see Data Types [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes + * + * @var AttributeValue|null */ private $value; @@ -75,6 +77,8 @@ final class AttributeValueUpdate * - `DELETE` - Nothing happens; there is no attribute to delete. * - `ADD` - DynamoDB creates a new item with the supplied primary key and number (or set) for the attribute value. The * only data types allowed are number, number set, string set or binary set. + * + * @var AttributeAction::*|null */ private $action; diff --git a/src/Service/DynamoDb/src/ValueObject/BillingModeSummary.php b/src/Service/DynamoDb/src/ValueObject/BillingModeSummary.php index afcec4e8a..ac52302cd 100644 --- a/src/Service/DynamoDb/src/ValueObject/BillingModeSummary.php +++ b/src/Service/DynamoDb/src/ValueObject/BillingModeSummary.php @@ -22,11 +22,15 @@ final class BillingModeSummary * predictable workloads. * - `PAY_PER_REQUEST` - Sets the read/write capacity mode to `PAY_PER_REQUEST`. We recommend using `PAY_PER_REQUEST` * for unpredictable workloads. + * + * @var BillingMode::*|null */ private $billingMode; /** * Represents the time when `PAY_PER_REQUEST` was last set as the read/write capacity mode. + * + * @var \DateTimeImmutable|null */ private $lastUpdateToPayPerRequestDateTime; diff --git a/src/Service/DynamoDb/src/ValueObject/CancellationReason.php b/src/Service/DynamoDb/src/ValueObject/CancellationReason.php index 366d00aa6..eb530c350 100644 --- a/src/Service/DynamoDb/src/ValueObject/CancellationReason.php +++ b/src/Service/DynamoDb/src/ValueObject/CancellationReason.php @@ -11,16 +11,22 @@ final class CancellationReason { /** * Item in the request which caused the transaction to get cancelled. + * + * @var array|null */ private $item; /** * Status code for the result of the cancelled transaction. + * + * @var string|null */ private $code; /** * Cancellation reason message description. + * + * @var string|null */ private $message; diff --git a/src/Service/DynamoDb/src/ValueObject/Capacity.php b/src/Service/DynamoDb/src/ValueObject/Capacity.php index 79a71d065..8a0753270 100644 --- a/src/Service/DynamoDb/src/ValueObject/Capacity.php +++ b/src/Service/DynamoDb/src/ValueObject/Capacity.php @@ -9,16 +9,22 @@ final class Capacity { /** * The total number of read capacity units consumed on a table or an index. + * + * @var float|null */ private $readCapacityUnits; /** * The total number of write capacity units consumed on a table or an index. + * + * @var float|null */ private $writeCapacityUnits; /** * The total number of capacity units consumed on a table or an index. + * + * @var float|null */ private $capacityUnits; diff --git a/src/Service/DynamoDb/src/ValueObject/Condition.php b/src/Service/DynamoDb/src/ValueObject/Condition.php index 974b729bb..26931b393 100644 --- a/src/Service/DynamoDb/src/ValueObject/Condition.php +++ b/src/Service/DynamoDb/src/ValueObject/Condition.php @@ -32,6 +32,8 @@ final class Condition * For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * * [^1]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters + * + * @var AttributeValue[]|null */ private $attributeValueList; @@ -134,6 +136,8 @@ final class Condition * *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html + * + * @var ComparisonOperator::* */ private $comparisonOperator; diff --git a/src/Service/DynamoDb/src/ValueObject/ConditionCheck.php b/src/Service/DynamoDb/src/ValueObject/ConditionCheck.php index 57f86f044..427f48f44 100644 --- a/src/Service/DynamoDb/src/ValueObject/ConditionCheck.php +++ b/src/Service/DynamoDb/src/ValueObject/ConditionCheck.php @@ -13,11 +13,15 @@ final class ConditionCheck { /** * The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute. + * + * @var array */ private $key; /** * Name of the table for the check item request. + * + * @var string */ private $tableName; @@ -26,6 +30,8 @@ final class ConditionCheck * expressions [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html + * + * @var string */ private $conditionExpression; @@ -34,6 +40,8 @@ final class ConditionCheck * names [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html + * + * @var array|null */ private $expressionAttributeNames; @@ -42,12 +50,16 @@ final class ConditionCheck * the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html + * + * @var array|null */ private $expressionAttributeValues; /** * Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `ConditionCheck` condition fails. For * `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL_OLD. + * + * @var ReturnValuesOnConditionCheckFailure::*|null */ private $returnValuesOnConditionCheckFailure; diff --git a/src/Service/DynamoDb/src/ValueObject/ConsumedCapacity.php b/src/Service/DynamoDb/src/ValueObject/ConsumedCapacity.php index 4e0b5cc1c..eaed79e60 100644 --- a/src/Service/DynamoDb/src/ValueObject/ConsumedCapacity.php +++ b/src/Service/DynamoDb/src/ValueObject/ConsumedCapacity.php @@ -14,36 +14,50 @@ final class ConsumedCapacity { /** * The name of the table that was affected by the operation. + * + * @var string|null */ private $tableName; /** * The total number of capacity units consumed by the operation. + * + * @var float|null */ private $capacityUnits; /** * The total number of read capacity units consumed by the operation. + * + * @var float|null */ private $readCapacityUnits; /** * The total number of write capacity units consumed by the operation. + * + * @var float|null */ private $writeCapacityUnits; /** * The amount of throughput consumed on the table affected by the operation. + * + * @var Capacity|null */ private $table; /** * The amount of throughput consumed on each local index affected by the operation. + * + * @var array|null */ private $localSecondaryIndexes; /** * The amount of throughput consumed on each global index affected by the operation. + * + * @var array|null */ private $globalSecondaryIndexes; diff --git a/src/Service/DynamoDb/src/ValueObject/CreateGlobalSecondaryIndexAction.php b/src/Service/DynamoDb/src/ValueObject/CreateGlobalSecondaryIndexAction.php index 24c9c3678..3d7641011 100644 --- a/src/Service/DynamoDb/src/ValueObject/CreateGlobalSecondaryIndexAction.php +++ b/src/Service/DynamoDb/src/ValueObject/CreateGlobalSecondaryIndexAction.php @@ -11,17 +11,23 @@ final class CreateGlobalSecondaryIndexAction { /** * The name of the global secondary index to be created. + * + * @var string */ private $indexName; /** * The key schema for the global secondary index. + * + * @var KeySchemaElement[] */ private $keySchema; /** * Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary * key attributes and index key attributes, which are automatically projected. + * + * @var Projection */ private $projection; @@ -32,6 +38,8 @@ final class CreateGlobalSecondaryIndexAction * *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html + * + * @var ProvisionedThroughput|null */ private $provisionedThroughput; diff --git a/src/Service/DynamoDb/src/ValueObject/CreateReplicationGroupMemberAction.php b/src/Service/DynamoDb/src/ValueObject/CreateReplicationGroupMemberAction.php index 65bda4039..21bcc1ded 100644 --- a/src/Service/DynamoDb/src/ValueObject/CreateReplicationGroupMemberAction.php +++ b/src/Service/DynamoDb/src/ValueObject/CreateReplicationGroupMemberAction.php @@ -12,6 +12,8 @@ final class CreateReplicationGroupMemberAction { /** * The Region where the new replica will be created. + * + * @var string */ private $regionName; @@ -19,21 +21,29 @@ final class CreateReplicationGroupMemberAction * The KMS key that should be used for KMS encryption in the new replica. To specify a key, use its key ID, Amazon * Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is * different from the default DynamoDB KMS key `alias/aws/dynamodb`. + * + * @var string|null */ private $kmsMasterKeyId; /** * Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings. + * + * @var ProvisionedThroughputOverride|null */ private $provisionedThroughputOverride; /** * Replica-specific global secondary index settings. + * + * @var ReplicaGlobalSecondaryIndex[]|null */ private $globalSecondaryIndexes; /** * Replica-specific table class. If not specified, uses the source table's table class. + * + * @var TableClass::*|null */ private $tableClassOverride; diff --git a/src/Service/DynamoDb/src/ValueObject/Delete.php b/src/Service/DynamoDb/src/ValueObject/Delete.php index f6ad74a25..e47893d9d 100644 --- a/src/Service/DynamoDb/src/ValueObject/Delete.php +++ b/src/Service/DynamoDb/src/ValueObject/Delete.php @@ -12,32 +12,44 @@ final class Delete { /** * The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute. + * + * @var array */ private $key; /** * Name of the table in which the item to be deleted resides. + * + * @var string */ private $tableName; /** * A condition that must be satisfied in order for a conditional delete to succeed. + * + * @var string|null */ private $conditionExpression; /** * One or more substitution tokens for attribute names in an expression. + * + * @var array|null */ private $expressionAttributeNames; /** * One or more values that can be substituted in an expression. + * + * @var array|null */ private $expressionAttributeValues; /** * Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `Delete` condition fails. For * `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL_OLD. + * + * @var ReturnValuesOnConditionCheckFailure::*|null */ private $returnValuesOnConditionCheckFailure; diff --git a/src/Service/DynamoDb/src/ValueObject/DeleteGlobalSecondaryIndexAction.php b/src/Service/DynamoDb/src/ValueObject/DeleteGlobalSecondaryIndexAction.php index 65c879650..002230fa4 100644 --- a/src/Service/DynamoDb/src/ValueObject/DeleteGlobalSecondaryIndexAction.php +++ b/src/Service/DynamoDb/src/ValueObject/DeleteGlobalSecondaryIndexAction.php @@ -11,6 +11,8 @@ final class DeleteGlobalSecondaryIndexAction { /** * The name of the global secondary index to be deleted. + * + * @var string */ private $indexName; diff --git a/src/Service/DynamoDb/src/ValueObject/DeleteReplicationGroupMemberAction.php b/src/Service/DynamoDb/src/ValueObject/DeleteReplicationGroupMemberAction.php index 88c0e97cf..efc68a025 100644 --- a/src/Service/DynamoDb/src/ValueObject/DeleteReplicationGroupMemberAction.php +++ b/src/Service/DynamoDb/src/ValueObject/DeleteReplicationGroupMemberAction.php @@ -11,6 +11,8 @@ final class DeleteReplicationGroupMemberAction { /** * The Region where the replica exists. + * + * @var string */ private $regionName; diff --git a/src/Service/DynamoDb/src/ValueObject/DeleteRequest.php b/src/Service/DynamoDb/src/ValueObject/DeleteRequest.php index 2cc25a6ce..55f992f87 100644 --- a/src/Service/DynamoDb/src/ValueObject/DeleteRequest.php +++ b/src/Service/DynamoDb/src/ValueObject/DeleteRequest.php @@ -12,6 +12,8 @@ final class DeleteRequest /** * A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's * primary key attributes must be specified, and their data types must match those of the table's key schema. + * + * @var array */ private $key; diff --git a/src/Service/DynamoDb/src/ValueObject/Endpoint.php b/src/Service/DynamoDb/src/ValueObject/Endpoint.php index bedeac374..130987343 100644 --- a/src/Service/DynamoDb/src/ValueObject/Endpoint.php +++ b/src/Service/DynamoDb/src/ValueObject/Endpoint.php @@ -12,11 +12,15 @@ final class Endpoint implements EndpointInterface { /** * IP address of the endpoint. + * + * @var string */ private $address; /** * Endpoint cache time to live (TTL) value. + * + * @var int */ private $cachePeriodInMinutes; diff --git a/src/Service/DynamoDb/src/ValueObject/ExpectedAttributeValue.php b/src/Service/DynamoDb/src/ValueObject/ExpectedAttributeValue.php index c9ddec733..9cdc9a70a 100644 --- a/src/Service/DynamoDb/src/ValueObject/ExpectedAttributeValue.php +++ b/src/Service/DynamoDb/src/ValueObject/ExpectedAttributeValue.php @@ -31,6 +31,8 @@ final class ExpectedAttributeValue * For more information, see Data Types [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes + * + * @var AttributeValue|null */ private $value; @@ -52,6 +54,8 @@ final class ExpectedAttributeValue * value is.) * - `Exists` is `false` but you also provide a `Value`. (You cannot expect an attribute to have a value, while also * expecting it not to exist.) + * + * @var bool|null */ private $exists; @@ -150,6 +154,8 @@ final class ExpectedAttributeValue * and less than, or equal to, the second element. If an item contains an `AttributeValue` element of a different type * than the one provided in the request, the value does not match. For example, `{"S":"6"}` does not compare to * `{"N":"6"}`. Also, `{"N":"6"}` does not compare to `{"NS":["6", "2", "1"]}` + * + * @var ComparisonOperator::*|null */ private $comparisonOperator; @@ -169,6 +175,8 @@ final class ExpectedAttributeValue * * [^1]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters * [^2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html + * + * @var AttributeValue[]|null */ private $attributeValueList; diff --git a/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndex.php b/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndex.php index 56187402b..eb1ae724d 100644 --- a/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndex.php +++ b/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndex.php @@ -11,6 +11,8 @@ final class GlobalSecondaryIndex { /** * The name of the global secondary index. The name must be unique among all other indexes on this table. + * + * @var string */ private $indexName; @@ -27,12 +29,16 @@ final class GlobalSecondaryIndex * > * > The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way * > DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + * + * @var KeySchemaElement[] */ private $keySchema; /** * Represents attributes that are copied (projected) from the table into the global secondary index. These are in * addition to the primary key attributes and index key attributes, which are automatically projected. + * + * @var Projection */ private $projection; @@ -43,6 +49,8 @@ final class GlobalSecondaryIndex * *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html + * + * @var ProvisionedThroughput|null */ private $provisionedThroughput; diff --git a/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndexDescription.php b/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndexDescription.php index 23a30d48e..91151d3e6 100644 --- a/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndexDescription.php +++ b/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndexDescription.php @@ -11,6 +11,8 @@ final class GlobalSecondaryIndexDescription { /** * The name of the global secondary index. + * + * @var string|null */ private $indexName; @@ -27,12 +29,16 @@ final class GlobalSecondaryIndexDescription * > * > The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way * > DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + * + * @var KeySchemaElement[]|null */ private $keySchema; /** * Represents attributes that are copied (projected) from the table into the global secondary index. These are in * addition to the primary key attributes and index key attributes, which are automatically projected. + * + * @var Projection|null */ private $projection; @@ -43,6 +49,8 @@ final class GlobalSecondaryIndexDescription * - `UPDATING` - The index is being updated. * - `DELETING` - The index is being deleted. * - `ACTIVE` - The index is ready for use. + * + * @var IndexStatus::*|null */ private $indexStatus; @@ -58,6 +66,8 @@ final class GlobalSecondaryIndexDescription * * > For indexes that were created during a `CreateTable` operation, the `Backfilling` attribute does not appear in the * > `DescribeTable` output. + * + * @var bool|null */ private $backfilling; @@ -68,23 +78,31 @@ final class GlobalSecondaryIndexDescription * *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html + * + * @var ProvisionedThroughputDescription|null */ private $provisionedThroughput; /** * The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent * changes might not be reflected in this value. + * + * @var int|null */ private $indexSizeBytes; /** * The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes * might not be reflected in this value. + * + * @var int|null */ private $itemCount; /** * The Amazon Resource Name (ARN) that uniquely identifies the index. + * + * @var string|null */ private $indexArn; diff --git a/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndexUpdate.php b/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndexUpdate.php index 378667510..43ca8a477 100644 --- a/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndexUpdate.php +++ b/src/Service/DynamoDb/src/ValueObject/GlobalSecondaryIndexUpdate.php @@ -14,6 +14,8 @@ final class GlobalSecondaryIndexUpdate /** * The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that * index. + * + * @var UpdateGlobalSecondaryIndexAction|null */ private $update; @@ -25,11 +27,15 @@ final class GlobalSecondaryIndexUpdate * - `AttributeDefinitions ` * - `Projection ` * - `ProvisionedThroughput ` + * + * @var CreateGlobalSecondaryIndexAction|null */ private $create; /** * The name of an existing global secondary index to be removed. + * + * @var DeleteGlobalSecondaryIndexAction|null */ private $delete; diff --git a/src/Service/DynamoDb/src/ValueObject/ItemCollectionMetrics.php b/src/Service/DynamoDb/src/ValueObject/ItemCollectionMetrics.php index 368eed12e..55ff8205c 100644 --- a/src/Service/DynamoDb/src/ValueObject/ItemCollectionMetrics.php +++ b/src/Service/DynamoDb/src/ValueObject/ItemCollectionMetrics.php @@ -11,6 +11,8 @@ final class ItemCollectionMetrics { /** * The partition key value of the item collection. This value is the same as the partition key value of the item. + * + * @var array|null */ private $itemCollectionKey; @@ -21,6 +23,8 @@ final class ItemCollectionMetrics * local secondary index is approaching its size limit. * * The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + * + * @var float[]|null */ private $sizeEstimateRangeGb; diff --git a/src/Service/DynamoDb/src/ValueObject/KeySchemaElement.php b/src/Service/DynamoDb/src/ValueObject/KeySchemaElement.php index d88570416..596dd8086 100644 --- a/src/Service/DynamoDb/src/ValueObject/KeySchemaElement.php +++ b/src/Service/DynamoDb/src/ValueObject/KeySchemaElement.php @@ -20,6 +20,8 @@ final class KeySchemaElement { /** * The name of a key attribute. + * + * @var string */ private $attributeName; @@ -35,6 +37,8 @@ final class KeySchemaElement * > * > The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way * > DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + * + * @var KeyType::* */ private $keyType; diff --git a/src/Service/DynamoDb/src/ValueObject/KeysAndAttributes.php b/src/Service/DynamoDb/src/ValueObject/KeysAndAttributes.php index fba385e45..f22558763 100644 --- a/src/Service/DynamoDb/src/ValueObject/KeysAndAttributes.php +++ b/src/Service/DynamoDb/src/ValueObject/KeysAndAttributes.php @@ -15,6 +15,8 @@ final class KeysAndAttributes { /** * The primary key attribute values that define the items and the attributes associated with the items. + * + * @var array[] */ private $keys; @@ -23,12 +25,16 @@ final class KeysAndAttributes * Parameters [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html + * + * @var string[]|null */ private $attributesToGet; /** * The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an * eventually consistent read is used. + * + * @var bool|null */ private $consistentRead; @@ -42,6 +48,8 @@ final class KeysAndAttributes * For more information, see Accessing Item Attributes [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html + * + * @var string|null */ private $projectionExpression; @@ -76,6 +84,8 @@ final class KeysAndAttributes * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html * [^2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html + * + * @var array|null */ private $expressionAttributeNames; diff --git a/src/Service/DynamoDb/src/ValueObject/LocalSecondaryIndex.php b/src/Service/DynamoDb/src/ValueObject/LocalSecondaryIndex.php index 57d05c813..6d3d8e80c 100644 --- a/src/Service/DynamoDb/src/ValueObject/LocalSecondaryIndex.php +++ b/src/Service/DynamoDb/src/ValueObject/LocalSecondaryIndex.php @@ -11,6 +11,8 @@ final class LocalSecondaryIndex { /** * The name of the local secondary index. The name must be unique among all other indexes on this table. + * + * @var string */ private $indexName; @@ -27,12 +29,16 @@ final class LocalSecondaryIndex * > * > The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way * > DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + * + * @var KeySchemaElement[] */ private $keySchema; /** * Represents attributes that are copied (projected) from the table into the local secondary index. These are in * addition to the primary key attributes and index key attributes, which are automatically projected. + * + * @var Projection */ private $projection; diff --git a/src/Service/DynamoDb/src/ValueObject/LocalSecondaryIndexDescription.php b/src/Service/DynamoDb/src/ValueObject/LocalSecondaryIndexDescription.php index 28f28206c..e528bbe74 100644 --- a/src/Service/DynamoDb/src/ValueObject/LocalSecondaryIndexDescription.php +++ b/src/Service/DynamoDb/src/ValueObject/LocalSecondaryIndexDescription.php @@ -9,6 +9,8 @@ final class LocalSecondaryIndexDescription { /** * Represents the name of the local secondary index. + * + * @var string|null */ private $indexName; @@ -25,29 +27,39 @@ final class LocalSecondaryIndexDescription * > * > The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way * > DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + * + * @var KeySchemaElement[]|null */ private $keySchema; /** * Represents attributes that are copied (projected) from the table into the global secondary index. These are in * addition to the primary key attributes and index key attributes, which are automatically projected. + * + * @var Projection|null */ private $projection; /** * The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent * changes might not be reflected in this value. + * + * @var int|null */ private $indexSizeBytes; /** * The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes * might not be reflected in this value. + * + * @var int|null */ private $itemCount; /** * The Amazon Resource Name (ARN) that uniquely identifies the index. + * + * @var string|null */ private $indexArn; diff --git a/src/Service/DynamoDb/src/ValueObject/Projection.php b/src/Service/DynamoDb/src/ValueObject/Projection.php index 4f6335c05..2c1d3e4dd 100644 --- a/src/Service/DynamoDb/src/ValueObject/Projection.php +++ b/src/Service/DynamoDb/src/ValueObject/Projection.php @@ -18,6 +18,8 @@ final class Projection * - `INCLUDE` - In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non-key * attributes that you specify. * - `ALL` - All of the table attributes are projected into the index. + * + * @var ProjectionType::*|null */ private $projectionType; @@ -27,6 +29,8 @@ final class Projection * For local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, * must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct * attributes when determining the total. + * + * @var string[]|null */ private $nonKeyAttributes; diff --git a/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughput.php b/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughput.php index 7c98f7a36..b39b9e401 100644 --- a/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughput.php +++ b/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughput.php @@ -22,6 +22,8 @@ final class ProvisionedThroughput * If read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html + * + * @var int */ private $readCapacityUnits; @@ -32,6 +34,8 @@ final class ProvisionedThroughput * If read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html + * + * @var int */ private $writeCapacityUnits; diff --git a/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughputDescription.php b/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughputDescription.php index 9f6f95fcf..4e3015f73 100644 --- a/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughputDescription.php +++ b/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughputDescription.php @@ -10,11 +10,15 @@ final class ProvisionedThroughputDescription { /** * The date and time of the last provisioned throughput increase for this table. + * + * @var \DateTimeImmutable|null */ private $lastIncreaseDateTime; /** * The date and time of the last provisioned throughput decrease for this table. + * + * @var \DateTimeImmutable|null */ private $lastDecreaseDateTime; @@ -24,6 +28,8 @@ final class ProvisionedThroughputDescription * Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html + * + * @var int|null */ private $numberOfDecreasesToday; @@ -31,11 +37,15 @@ final class ProvisionedThroughputDescription * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`. * Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 * `ReadCapacityUnits` per second provides 100 eventually consistent `ReadCapacityUnits` per second. + * + * @var int|null */ private $readCapacityUnits; /** * The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`. + * + * @var int|null */ private $writeCapacityUnits; diff --git a/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughputOverride.php b/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughputOverride.php index cd56c795d..967b47938 100644 --- a/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughputOverride.php +++ b/src/Service/DynamoDb/src/ValueObject/ProvisionedThroughputOverride.php @@ -10,6 +10,8 @@ final class ProvisionedThroughputOverride { /** * Replica-specific read capacity units. If not specified, uses the source table's read capacity settings. + * + * @var int|null */ private $readCapacityUnits; diff --git a/src/Service/DynamoDb/src/ValueObject/Put.php b/src/Service/DynamoDb/src/ValueObject/Put.php index 7e276bf06..29f4fa6e6 100644 --- a/src/Service/DynamoDb/src/ValueObject/Put.php +++ b/src/Service/DynamoDb/src/ValueObject/Put.php @@ -15,32 +15,44 @@ final class Put * of the table's primary key attributes must be specified, and their data types must match those of the table's key * schema. If any attributes are present in the item that are part of an index key schema for the table, their types * must match the index key schema. + * + * @var array */ private $item; /** * Name of the table in which to write the item. + * + * @var string */ private $tableName; /** * A condition that must be satisfied in order for a conditional update to succeed. + * + * @var string|null */ private $conditionExpression; /** * One or more substitution tokens for attribute names in an expression. + * + * @var array|null */ private $expressionAttributeNames; /** * One or more values that can be substituted in an expression. + * + * @var array|null */ private $expressionAttributeValues; /** * Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `Put` condition fails. For * `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE and ALL_OLD. + * + * @var ReturnValuesOnConditionCheckFailure::*|null */ private $returnValuesOnConditionCheckFailure; diff --git a/src/Service/DynamoDb/src/ValueObject/PutRequest.php b/src/Service/DynamoDb/src/ValueObject/PutRequest.php index 650d38384..059b3c337 100644 --- a/src/Service/DynamoDb/src/ValueObject/PutRequest.php +++ b/src/Service/DynamoDb/src/ValueObject/PutRequest.php @@ -14,6 +14,8 @@ final class PutRequest * All of the table's primary key attributes must be specified, and their data types must match those of the table's key * schema. If any attributes are present in the item that are part of an index key schema for the table, their types * must match the index key schema. + * + * @var array */ private $item; diff --git a/src/Service/DynamoDb/src/ValueObject/ReplicaDescription.php b/src/Service/DynamoDb/src/ValueObject/ReplicaDescription.php index 43209efd8..7076e2877 100644 --- a/src/Service/DynamoDb/src/ValueObject/ReplicaDescription.php +++ b/src/Service/DynamoDb/src/ValueObject/ReplicaDescription.php @@ -11,6 +11,8 @@ final class ReplicaDescription { /** * The name of the Region. + * + * @var string|null */ private $regionName; @@ -30,40 +32,57 @@ final class ReplicaDescription * * > If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the * > replication group. The replica will not be deleted and replication will stop from and to this region. + * + * @var ReplicaStatus::*|null */ private $replicaStatus; /** * Detailed information about the replica status. + * + * @var string|null */ private $replicaStatusDescription; /** * Specifies the progress of a Create, Update, or Delete action on the replica as a percentage. + * + * @var string|null */ private $replicaStatusPercentProgress; /** * The KMS key of the replica that will be used for KMS encryption. + * + * @var string|null */ private $kmsMasterKeyId; /** * Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings. + * + * @var ProvisionedThroughputOverride|null */ private $provisionedThroughputOverride; /** * Replica-specific global secondary index settings. + * + * @var ReplicaGlobalSecondaryIndexDescription[]|null */ private $globalSecondaryIndexes; /** * The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the * `ReplicaStatus` property. + * + * @var \DateTimeImmutable|null */ private $replicaInaccessibleDateTime; + /** + * @var TableClassSummary|null + */ private $replicaTableClassSummary; /** diff --git a/src/Service/DynamoDb/src/ValueObject/ReplicaGlobalSecondaryIndex.php b/src/Service/DynamoDb/src/ValueObject/ReplicaGlobalSecondaryIndex.php index 8228b95c6..80613567a 100644 --- a/src/Service/DynamoDb/src/ValueObject/ReplicaGlobalSecondaryIndex.php +++ b/src/Service/DynamoDb/src/ValueObject/ReplicaGlobalSecondaryIndex.php @@ -11,12 +11,16 @@ final class ReplicaGlobalSecondaryIndex { /** * The name of the global secondary index. + * + * @var string */ private $indexName; /** * Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity * settings. + * + * @var ProvisionedThroughputOverride|null */ private $provisionedThroughputOverride; diff --git a/src/Service/DynamoDb/src/ValueObject/ReplicaGlobalSecondaryIndexDescription.php b/src/Service/DynamoDb/src/ValueObject/ReplicaGlobalSecondaryIndexDescription.php index 03f6f9969..ba5ca4e11 100644 --- a/src/Service/DynamoDb/src/ValueObject/ReplicaGlobalSecondaryIndexDescription.php +++ b/src/Service/DynamoDb/src/ValueObject/ReplicaGlobalSecondaryIndexDescription.php @@ -9,11 +9,15 @@ final class ReplicaGlobalSecondaryIndexDescription { /** * The name of the global secondary index. + * + * @var string|null */ private $indexName; /** * If not described, uses the source table GSI's read capacity settings. + * + * @var ProvisionedThroughputOverride|null */ private $provisionedThroughputOverride; diff --git a/src/Service/DynamoDb/src/ValueObject/ReplicationGroupUpdate.php b/src/Service/DynamoDb/src/ValueObject/ReplicationGroupUpdate.php index 847f2b633..dbe632292 100644 --- a/src/Service/DynamoDb/src/ValueObject/ReplicationGroupUpdate.php +++ b/src/Service/DynamoDb/src/ValueObject/ReplicationGroupUpdate.php @@ -18,16 +18,22 @@ final class ReplicationGroupUpdate { /** * The parameters required for creating a replica for the table. + * + * @var CreateReplicationGroupMemberAction|null */ private $create; /** * The parameters required for updating a replica for the table. + * + * @var UpdateReplicationGroupMemberAction|null */ private $update; /** * The parameters required for deleting a replica for the table. + * + * @var DeleteReplicationGroupMemberAction|null */ private $delete; diff --git a/src/Service/DynamoDb/src/ValueObject/RestoreSummary.php b/src/Service/DynamoDb/src/ValueObject/RestoreSummary.php index fa1b564d7..8d3f9164f 100644 --- a/src/Service/DynamoDb/src/ValueObject/RestoreSummary.php +++ b/src/Service/DynamoDb/src/ValueObject/RestoreSummary.php @@ -11,21 +11,29 @@ final class RestoreSummary { /** * The Amazon Resource Name (ARN) of the backup from which the table was restored. + * + * @var string|null */ private $sourceBackupArn; /** * The ARN of the source table of the backup that is being restored. + * + * @var string|null */ private $sourceTableArn; /** * Point in time or source backup time. + * + * @var \DateTimeImmutable */ private $restoreDateTime; /** * Indicates if a restore is in progress or not. + * + * @var bool */ private $restoreInProgress; diff --git a/src/Service/DynamoDb/src/ValueObject/SSEDescription.php b/src/Service/DynamoDb/src/ValueObject/SSEDescription.php index a6c214f70..433dd365d 100644 --- a/src/Service/DynamoDb/src/ValueObject/SSEDescription.php +++ b/src/Service/DynamoDb/src/ValueObject/SSEDescription.php @@ -15,6 +15,8 @@ final class SSEDescription * * - `ENABLED` - Server-side encryption is enabled. * - `UPDATING` - Server-side encryption is being updated. + * + * @var SSEStatus::*|null */ private $status; @@ -23,11 +25,15 @@ final class SSEDescription * * - `KMS` - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed * by KMS (KMS charges apply). + * + * @var SSEType::*|null */ private $sseType; /** * The KMS key ARN used for the KMS encryption. + * + * @var string|null */ private $kmsMasterKeyArn; @@ -36,6 +42,8 @@ final class SSEDescription * attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB * will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this * date. + * + * @var \DateTimeImmutable|null */ private $inaccessibleEncryptionDateTime; diff --git a/src/Service/DynamoDb/src/ValueObject/SSESpecification.php b/src/Service/DynamoDb/src/ValueObject/SSESpecification.php index 1e734e69e..4065faf39 100644 --- a/src/Service/DynamoDb/src/ValueObject/SSESpecification.php +++ b/src/Service/DynamoDb/src/ValueObject/SSESpecification.php @@ -15,6 +15,8 @@ final class SSESpecification * owned key. If enabled (true), server-side encryption type is set to `KMS` and an Amazon Web Services managed key is * used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services * owned key. + * + * @var bool|null */ private $enabled; @@ -23,6 +25,8 @@ final class SSESpecification * * - `KMS` - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed * by KMS (KMS charges apply). + * + * @var SSEType::*|null */ private $sseType; @@ -30,6 +34,8 @@ final class SSESpecification * The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), * alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default * DynamoDB key `alias/aws/dynamodb`. + * + * @var string|null */ private $kmsMasterKeyId; diff --git a/src/Service/DynamoDb/src/ValueObject/StreamSpecification.php b/src/Service/DynamoDb/src/ValueObject/StreamSpecification.php index 09def8ee1..b4370db6f 100644 --- a/src/Service/DynamoDb/src/ValueObject/StreamSpecification.php +++ b/src/Service/DynamoDb/src/ValueObject/StreamSpecification.php @@ -12,6 +12,8 @@ final class StreamSpecification { /** * Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. + * + * @var bool */ private $streamEnabled; @@ -23,6 +25,8 @@ final class StreamSpecification * - `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream. * - `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream. * - `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream. + * + * @var StreamViewType::*|null */ private $streamViewType; diff --git a/src/Service/DynamoDb/src/ValueObject/TableClassSummary.php b/src/Service/DynamoDb/src/ValueObject/TableClassSummary.php index 30c7f002d..c2abb83b6 100644 --- a/src/Service/DynamoDb/src/ValueObject/TableClassSummary.php +++ b/src/Service/DynamoDb/src/ValueObject/TableClassSummary.php @@ -11,11 +11,15 @@ final class TableClassSummary { /** * The table class of the specified table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`. + * + * @var TableClass::*|null */ private $tableClass; /** * The date and time at which the table class was last updated. + * + * @var \DateTimeImmutable|null */ private $lastUpdateDateTime; diff --git a/src/Service/DynamoDb/src/ValueObject/TableDescription.php b/src/Service/DynamoDb/src/ValueObject/TableDescription.php index 7ef360b5c..8aab89d13 100644 --- a/src/Service/DynamoDb/src/ValueObject/TableDescription.php +++ b/src/Service/DynamoDb/src/ValueObject/TableDescription.php @@ -17,11 +17,15 @@ final class TableDescription * * - `AttributeName` - The name of the attribute. * - `AttributeType` - The data type for the attribute. + * + * @var AttributeDefinition[]|null */ private $attributeDefinitions; /** * The name of the table. + * + * @var string|null */ private $tableName; @@ -46,6 +50,8 @@ final class TableDescription * For more information about primary keys, see Primary Key [^1] in the *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey + * + * @var KeySchemaElement[]|null */ private $keySchema; @@ -62,6 +68,8 @@ final class TableDescription * remains inaccessible for more than seven days. * - `ARCHIVING` - The table is being archived. Operations are not allowed until archival is complete. * - `ARCHIVED` - The table has been archived. See the ArchivalReason for more information. + * + * @var TableStatus::*|null */ private $tableStatus; @@ -69,39 +77,53 @@ final class TableDescription * The date and time when the table was created, in UNIX epoch time [^1] format. * * [^1]: http://www.epochconverter.com/ + * + * @var \DateTimeImmutable|null */ private $creationDateTime; /** * The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about * increases and decreases. + * + * @var ProvisionedThroughputDescription|null */ private $provisionedThroughput; /** * The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent * changes might not be reflected in this value. + * + * @var int|null */ private $tableSizeBytes; /** * The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes * might not be reflected in this value. + * + * @var int|null */ private $itemCount; /** * The Amazon Resource Name (ARN) that uniquely identifies the table. + * + * @var string|null */ private $tableArn; /** * Unique identifier for the table for which the backup was created. + * + * @var string|null */ private $tableId; /** * Contains the details for the read/write capacity mode. + * + * @var BillingModeSummary|null */ private $billingModeSummary; @@ -135,6 +157,8 @@ final class TableDescription * hours. Recent changes might not be reflected in this value. * * If the table is in the `DELETING` state, no information about indexes will be returned. + * + * @var LocalSecondaryIndexDescription[]|null */ private $localSecondaryIndexes; @@ -184,11 +208,15 @@ final class TableDescription * and write capacity units, along with data about increases and decreases. * * If the table is in the `DELETING` state, no information about indexes will be returned. + * + * @var GlobalSecondaryIndexDescription[]|null */ private $globalSecondaryIndexes; /** * The current DynamoDB Streams configuration for the table. + * + * @var StreamSpecification|null */ private $streamSpecification; @@ -202,11 +230,15 @@ final class TableDescription * - Amazon Web Services customer ID * - Table name * - `StreamLabel` + * + * @var string|null */ private $latestStreamLabel; /** * The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. + * + * @var string|null */ private $latestStreamArn; @@ -214,36 +246,50 @@ final class TableDescription * Represents the version of global tables [^1] in use, if the table is replicated across Amazon Web Services Regions. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html + * + * @var string|null */ private $globalTableVersion; /** * Represents replicas of the table. + * + * @var ReplicaDescription[]|null */ private $replicas; /** * Contains details for the restore. + * + * @var RestoreSummary|null */ private $restoreSummary; /** * The description of the server-side encryption status on the specified table. + * + * @var SSEDescription|null */ private $sseDescription; /** * Contains information about the table archive. + * + * @var ArchivalSummary|null */ private $archivalSummary; /** * Contains details of the table class. + * + * @var TableClassSummary|null */ private $tableClassSummary; /** * Indicates whether deletion protection is enabled (true) or disabled (false) on the table. + * + * @var bool|null */ private $deletionProtectionEnabled; diff --git a/src/Service/DynamoDb/src/ValueObject/Tag.php b/src/Service/DynamoDb/src/ValueObject/Tag.php index 19ffacaf5..984699da2 100644 --- a/src/Service/DynamoDb/src/ValueObject/Tag.php +++ b/src/Service/DynamoDb/src/ValueObject/Tag.php @@ -21,11 +21,15 @@ final class Tag /** * The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. * If you try to add an existing tag (same key), the existing tag value will be updated to the new value. + * + * @var string */ private $key; /** * The value of the tag. Tag values are case-sensitive and can be null. + * + * @var string */ private $value; diff --git a/src/Service/DynamoDb/src/ValueObject/TimeToLiveSpecification.php b/src/Service/DynamoDb/src/ValueObject/TimeToLiveSpecification.php index 7ed7e4a9b..3a4a202dd 100644 --- a/src/Service/DynamoDb/src/ValueObject/TimeToLiveSpecification.php +++ b/src/Service/DynamoDb/src/ValueObject/TimeToLiveSpecification.php @@ -11,11 +11,15 @@ final class TimeToLiveSpecification { /** * Indicates whether TTL is to be enabled (true) or disabled (false) on the table. + * + * @var bool */ private $enabled; /** * The name of the TTL attribute used to store the expiration time for items in the table. + * + * @var string */ private $attributeName; diff --git a/src/Service/DynamoDb/src/ValueObject/TransactWriteItem.php b/src/Service/DynamoDb/src/ValueObject/TransactWriteItem.php index f0c098f2d..2fee36e68 100644 --- a/src/Service/DynamoDb/src/ValueObject/TransactWriteItem.php +++ b/src/Service/DynamoDb/src/ValueObject/TransactWriteItem.php @@ -10,21 +10,29 @@ final class TransactWriteItem { /** * A request to perform a check item operation. + * + * @var ConditionCheck|null */ private $conditionCheck; /** * A request to perform a `PutItem` operation. + * + * @var Put|null */ private $put; /** * A request to perform a `DeleteItem` operation. + * + * @var Delete|null */ private $delete; /** * A request to perform an `UpdateItem` operation. + * + * @var Update|null */ private $update; diff --git a/src/Service/DynamoDb/src/ValueObject/Update.php b/src/Service/DynamoDb/src/ValueObject/Update.php index 90702eb86..cfecea955 100644 --- a/src/Service/DynamoDb/src/ValueObject/Update.php +++ b/src/Service/DynamoDb/src/ValueObject/Update.php @@ -12,38 +12,52 @@ final class Update { /** * The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. + * + * @var array */ private $key; /** * An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) * for them. + * + * @var string */ private $updateExpression; /** * Name of the table for the `UpdateItem` request. + * + * @var string */ private $tableName; /** * A condition that must be satisfied in order for a conditional update to succeed. + * + * @var string|null */ private $conditionExpression; /** * One or more substitution tokens for attribute names in an expression. + * + * @var array|null */ private $expressionAttributeNames; /** * One or more values that can be substituted in an expression. + * + * @var array|null */ private $expressionAttributeValues; /** * Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `Update` condition fails. For * `ReturnValuesOnConditionCheckFailure`, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW. + * + * @var ReturnValuesOnConditionCheckFailure::*|null */ private $returnValuesOnConditionCheckFailure; diff --git a/src/Service/DynamoDb/src/ValueObject/UpdateGlobalSecondaryIndexAction.php b/src/Service/DynamoDb/src/ValueObject/UpdateGlobalSecondaryIndexAction.php index b3b2b3712..57d879e83 100644 --- a/src/Service/DynamoDb/src/ValueObject/UpdateGlobalSecondaryIndexAction.php +++ b/src/Service/DynamoDb/src/ValueObject/UpdateGlobalSecondaryIndexAction.php @@ -11,6 +11,8 @@ final class UpdateGlobalSecondaryIndexAction { /** * The name of the global secondary index to be updated. + * + * @var string */ private $indexName; @@ -21,6 +23,8 @@ final class UpdateGlobalSecondaryIndexAction * *Amazon DynamoDB Developer Guide*. * * [^1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html + * + * @var ProvisionedThroughput */ private $provisionedThroughput; diff --git a/src/Service/DynamoDb/src/ValueObject/UpdateReplicationGroupMemberAction.php b/src/Service/DynamoDb/src/ValueObject/UpdateReplicationGroupMemberAction.php index 213800d4a..0e8aa7515 100644 --- a/src/Service/DynamoDb/src/ValueObject/UpdateReplicationGroupMemberAction.php +++ b/src/Service/DynamoDb/src/ValueObject/UpdateReplicationGroupMemberAction.php @@ -12,6 +12,8 @@ final class UpdateReplicationGroupMemberAction { /** * The Region where the replica exists. + * + * @var string */ private $regionName; @@ -19,21 +21,29 @@ final class UpdateReplicationGroupMemberAction * The KMS key of the replica that should be used for KMS encryption. To specify a key, use its key ID, Amazon Resource * Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from * the default DynamoDB KMS key `alias/aws/dynamodb`. + * + * @var string|null */ private $kmsMasterKeyId; /** * Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings. + * + * @var ProvisionedThroughputOverride|null */ private $provisionedThroughputOverride; /** * Replica-specific global secondary index settings. + * + * @var ReplicaGlobalSecondaryIndex[]|null */ private $globalSecondaryIndexes; /** * Replica-specific table class. If not specified, uses the source table's table class. + * + * @var TableClass::*|null */ private $tableClassOverride; diff --git a/src/Service/DynamoDb/src/ValueObject/WriteRequest.php b/src/Service/DynamoDb/src/ValueObject/WriteRequest.php index 21c16d408..10c084c3e 100644 --- a/src/Service/DynamoDb/src/ValueObject/WriteRequest.php +++ b/src/Service/DynamoDb/src/ValueObject/WriteRequest.php @@ -11,11 +11,15 @@ final class WriteRequest { /** * A request to perform a `PutItem` operation. + * + * @var PutRequest|null */ private $putRequest; /** * A request to perform a `DeleteItem` operation. + * + * @var DeleteRequest|null */ private $deleteRequest; diff --git a/src/Service/Ecr/src/Result/GetAuthorizationTokenResponse.php b/src/Service/Ecr/src/Result/GetAuthorizationTokenResponse.php index 1c60e6014..9d903e952 100644 --- a/src/Service/Ecr/src/Result/GetAuthorizationTokenResponse.php +++ b/src/Service/Ecr/src/Result/GetAuthorizationTokenResponse.php @@ -10,6 +10,8 @@ class GetAuthorizationTokenResponse extends Result { /** * A list of authorization token data objects that correspond to the `registryIds` values in the request. + * + * @var AuthorizationData[] */ private $authorizationData; diff --git a/src/Service/Ecr/src/ValueObject/AuthorizationData.php b/src/Service/Ecr/src/ValueObject/AuthorizationData.php index 7cf88792a..c30db0b78 100644 --- a/src/Service/Ecr/src/ValueObject/AuthorizationData.php +++ b/src/Service/Ecr/src/ValueObject/AuthorizationData.php @@ -10,12 +10,16 @@ final class AuthorizationData /** * A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is * decoded, it is presented in the format `user:password` for private registry authentication using `docker login`. + * + * @var string|null */ private $authorizationToken; /** * The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 * hours. + * + * @var \DateTimeImmutable|null */ private $expiresAt; @@ -23,6 +27,8 @@ final class AuthorizationData * The registry URL to use for this authorization token in a `docker login` command. The Amazon ECR registry URL format * is `https://aws_account_id.dkr.ecr.region.amazonaws.com`. For example, * `https://012345678910.dkr.ecr.us-east-1.amazonaws.com`.. + * + * @var string|null */ private $proxyEndpoint; diff --git a/src/Service/ElastiCache/src/Result/CacheClusterMessage.php b/src/Service/ElastiCache/src/Result/CacheClusterMessage.php index 700c84e1c..a2fa7e56f 100644 --- a/src/Service/ElastiCache/src/Result/CacheClusterMessage.php +++ b/src/Service/ElastiCache/src/Result/CacheClusterMessage.php @@ -30,11 +30,15 @@ class CacheClusterMessage extends Result implements \IteratorAggregate { /** * Provides an identifier to allow retrieval of paginated results. + * + * @var string|null */ private $marker; /** * A list of clusters. Each item in the list contains detailed information about one cluster. + * + * @var CacheCluster[] */ private $cacheClusters; diff --git a/src/Service/ElastiCache/src/ValueObject/CacheCluster.php b/src/Service/ElastiCache/src/ValueObject/CacheCluster.php index e2fce9fb6..f6e9d10d6 100644 --- a/src/Service/ElastiCache/src/ValueObject/CacheCluster.php +++ b/src/Service/ElastiCache/src/ValueObject/CacheCluster.php @@ -13,6 +13,8 @@ final class CacheCluster { /** * The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster. + * + * @var string|null */ private $cacheClusterId; @@ -21,11 +23,15 @@ final class CacheCluster * The configuration endpoint will always have `.cfg` in it. * * Example: `mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211` + * + * @var Endpoint|null */ private $configurationEndpoint; /** * The URL of the web page where you can download the latest ElastiCache client library. + * + * @var string|null */ private $clientDownloadLandingPage; @@ -107,22 +113,30 @@ final class CacheCluster * * [^1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion * [^2]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion + * + * @var string|null */ private $cacheNodeType; /** * The name of the cache engine (`memcached` or `redis`) to be used for this cluster. + * + * @var string|null */ private $engine; /** * The version of the cache engine that is used in this cluster. + * + * @var string|null */ private $engineVersion; /** * The current state of this cluster, one of the following values: `available`, `creating`, `deleted`, `deleting`, * `incompatible-network`, `modifying`, `rebooting cluster nodes`, `restore-failed`, or `snapshotting`. + * + * @var string|null */ private $cacheClusterStatus; @@ -131,22 +145,30 @@ final class CacheCluster * * For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and * 40. + * + * @var int|null */ private $numCacheNodes; /** * The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in * different Availability Zones. + * + * @var string|null */ private $preferredAvailabilityZone; /** * The outpost ARN in which the cache cluster is created. + * + * @var string|null */ private $preferredOutpostArn; /** * The date and time when the cluster was created. + * + * @var \DateTimeImmutable|null */ private $cacheClusterCreateTime; @@ -165,51 +187,72 @@ final class CacheCluster * - `sat` * * Example: `sun:23:00-mon:01:30` + * + * @var string|null */ private $preferredMaintenanceWindow; + /** + * @var PendingModifiedValues|null + */ private $pendingModifiedValues; /** * Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to * subscribers using Amazon Simple Notification Service (SNS). + * + * @var NotificationConfiguration|null */ private $notificationConfiguration; /** * A list of cache security group elements, composed of name and status sub-elements. + * + * @var CacheSecurityGroupMembership[]|null */ private $cacheSecurityGroups; /** * Status of the cache parameter group. + * + * @var CacheParameterGroupStatus|null */ private $cacheParameterGroup; /** * The name of the cache subnet group associated with the cluster. + * + * @var string|null */ private $cacheSubnetGroupName; /** * A list of cache nodes that are members of the cluster. + * + * @var CacheNode[]|null */ private $cacheNodes; /** *  If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next * auto minor version upgrade campaign. This parameter is disabled for previous versions. + * + * @var bool|null */ private $autoMinorVersionUpgrade; /** * A list of VPC Security Groups associated with the cluster. + * + * @var SecurityGroupMembership[]|null */ private $securityGroups; /** * The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any * replication group. + * + * @var string|null */ private $replicationGroupId; @@ -218,6 +261,8 @@ final class CacheCluster * you set `SnapshotRetentionLimit` to 5, a snapshot that was taken today is retained for 5 days before being deleted. * * ! If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + * + * @var int|null */ private $snapshotRetentionLimit; @@ -225,6 +270,8 @@ final class CacheCluster * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. * * Example: `05:00-09:00` + * + * @var string|null */ private $snapshotWindow; @@ -232,11 +279,15 @@ final class CacheCluster * A flag that enables using an `AuthToken` (password) when issuing Redis commands. * * Default: `false` + * + * @var bool|null */ private $authTokenEnabled; /** * The date the auth token was last modified. + * + * @var \DateTimeImmutable|null */ private $authTokenLastModifiedDate; @@ -247,6 +298,8 @@ final class CacheCluster * later. * * Default: `false` + * + * @var bool|null */ private $transitEncryptionEnabled; @@ -260,21 +313,29 @@ final class CacheCluster * later. * * Default: `false` + * + * @var bool|null */ private $atRestEncryptionEnabled; /** * The ARN (Amazon Resource Name) of the cache cluster. + * + * @var string|null */ private $arn; /** * A boolean value indicating whether log delivery is enabled for the replication group. + * + * @var bool|null */ private $replicationGroupLogDeliveryEnabled; /** * Returns the destination, format and type of the logs. + * + * @var LogDeliveryConfiguration[]|null */ private $logDeliveryConfigurations; @@ -283,6 +344,8 @@ final class CacheCluster * or Memcached engine version 1.6.6 on all instances built on the Nitro system [^1]. * * [^1]: http://aws.amazon.com/ec2/nitro/ + * + * @var NetworkType::*|null */ private $networkType; @@ -291,11 +354,15 @@ final class CacheCluster * engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system [^1]. * * [^1]: http://aws.amazon.com/ec2/nitro/ + * + * @var IpDiscovery::*|null */ private $ipDiscovery; /** * A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. + * + * @var TransitEncryptionMode::*|null */ private $transitEncryptionMode; diff --git a/src/Service/ElastiCache/src/ValueObject/CacheNode.php b/src/Service/ElastiCache/src/ValueObject/CacheNode.php index 4a33c67d7..c087d4141 100644 --- a/src/Service/ElastiCache/src/ValueObject/CacheNode.php +++ b/src/Service/ElastiCache/src/ValueObject/CacheNode.php @@ -87,43 +87,59 @@ final class CacheNode /** * The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and * node ID uniquely identifies every cache node used in a customer's Amazon account. + * + * @var string|null */ private $cacheNodeId; /** * The current state of this cache node, one of the following values: `available`, `creating`, `rebooting`, or * `deleting`. + * + * @var string|null */ private $cacheNodeStatus; /** * The date and time when the cache node was created. + * + * @var \DateTimeImmutable|null */ private $cacheNodeCreateTime; /** * The hostname for connecting to this cache node. + * + * @var Endpoint|null */ private $endpoint; /** * The status of the parameter group applied to this cache node. + * + * @var string|null */ private $parameterGroupStatus; /** * The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not * associated with a primary cluster. + * + * @var string|null */ private $sourceCacheNodeId; /** * The Availability Zone where this node was created and now resides. + * + * @var string|null */ private $customerAvailabilityZone; /** * The customer outpost ARN of the cache node. + * + * @var string|null */ private $customerOutpostArn; diff --git a/src/Service/ElastiCache/src/ValueObject/CacheParameterGroupStatus.php b/src/Service/ElastiCache/src/ValueObject/CacheParameterGroupStatus.php index 7dddb1cc6..294770b83 100644 --- a/src/Service/ElastiCache/src/ValueObject/CacheParameterGroupStatus.php +++ b/src/Service/ElastiCache/src/ValueObject/CacheParameterGroupStatus.php @@ -9,17 +9,23 @@ final class CacheParameterGroupStatus { /** * The name of the cache parameter group. + * + * @var string|null */ private $cacheParameterGroupName; /** * The status of parameter updates. + * + * @var string|null */ private $parameterApplyStatus; /** * A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric * identifier (0001, 0002, etc.). + * + * @var string[]|null */ private $cacheNodeIdsToReboot; diff --git a/src/Service/ElastiCache/src/ValueObject/CacheSecurityGroupMembership.php b/src/Service/ElastiCache/src/ValueObject/CacheSecurityGroupMembership.php index eb30c2ffc..639dccc17 100644 --- a/src/Service/ElastiCache/src/ValueObject/CacheSecurityGroupMembership.php +++ b/src/Service/ElastiCache/src/ValueObject/CacheSecurityGroupMembership.php @@ -9,12 +9,16 @@ final class CacheSecurityGroupMembership { /** * The name of the cache security group. + * + * @var string|null */ private $cacheSecurityGroupName; /** * The membership status in the cache security group. The status changes when a cache security group is modified, or * when the cache security groups assigned to a cluster are modified. + * + * @var string|null */ private $status; diff --git a/src/Service/ElastiCache/src/ValueObject/CloudWatchLogsDestinationDetails.php b/src/Service/ElastiCache/src/ValueObject/CloudWatchLogsDestinationDetails.php index 7c8fcb0c3..7b2ce843c 100644 --- a/src/Service/ElastiCache/src/ValueObject/CloudWatchLogsDestinationDetails.php +++ b/src/Service/ElastiCache/src/ValueObject/CloudWatchLogsDestinationDetails.php @@ -9,6 +9,8 @@ final class CloudWatchLogsDestinationDetails { /** * The name of the CloudWatch Logs log group. + * + * @var string|null */ private $logGroup; diff --git a/src/Service/ElastiCache/src/ValueObject/DestinationDetails.php b/src/Service/ElastiCache/src/ValueObject/DestinationDetails.php index ee7386068..c8e437ce8 100644 --- a/src/Service/ElastiCache/src/ValueObject/DestinationDetails.php +++ b/src/Service/ElastiCache/src/ValueObject/DestinationDetails.php @@ -9,11 +9,15 @@ final class DestinationDetails { /** * The configuration details of the CloudWatch Logs destination. + * + * @var CloudWatchLogsDestinationDetails|null */ private $cloudWatchLogsDetails; /** * The configuration details of the Kinesis Data Firehose destination. + * + * @var KinesisFirehoseDestinationDetails|null */ private $kinesisFirehoseDetails; diff --git a/src/Service/ElastiCache/src/ValueObject/Endpoint.php b/src/Service/ElastiCache/src/ValueObject/Endpoint.php index 1f7245a1a..d43f3a26c 100644 --- a/src/Service/ElastiCache/src/ValueObject/Endpoint.php +++ b/src/Service/ElastiCache/src/ValueObject/Endpoint.php @@ -9,11 +9,15 @@ final class Endpoint { /** * The DNS hostname of the cache node. + * + * @var string|null */ private $address; /** * The port number that the cache engine is listening on. + * + * @var int|null */ private $port; diff --git a/src/Service/ElastiCache/src/ValueObject/KinesisFirehoseDestinationDetails.php b/src/Service/ElastiCache/src/ValueObject/KinesisFirehoseDestinationDetails.php index 70109d496..1bc90df94 100644 --- a/src/Service/ElastiCache/src/ValueObject/KinesisFirehoseDestinationDetails.php +++ b/src/Service/ElastiCache/src/ValueObject/KinesisFirehoseDestinationDetails.php @@ -9,6 +9,8 @@ final class KinesisFirehoseDestinationDetails { /** * The name of the Kinesis Data Firehose delivery stream. + * + * @var string|null */ private $deliveryStream; diff --git a/src/Service/ElastiCache/src/ValueObject/LogDeliveryConfiguration.php b/src/Service/ElastiCache/src/ValueObject/LogDeliveryConfiguration.php index c8871fa7d..cbed208ed 100644 --- a/src/Service/ElastiCache/src/ValueObject/LogDeliveryConfiguration.php +++ b/src/Service/ElastiCache/src/ValueObject/LogDeliveryConfiguration.php @@ -16,32 +16,44 @@ final class LogDeliveryConfiguration * Refers to slow-log [^1] or engine-log. * * [^1]: https://redis.io/commands/slowlog + * + * @var LogType::*|null */ private $logType; /** * Returns the destination type, either `cloudwatch-logs` or `kinesis-firehose`. + * + * @var DestinationType::*|null */ private $destinationType; /** * Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. + * + * @var DestinationDetails|null */ private $destinationDetails; /** * Returns the log format, either JSON or TEXT. + * + * @var LogFormat::*|null */ private $logFormat; /** * Returns the log delivery configuration status. Values are one of `enabling` | `disabling` | `modifying` | `active` | * `error`. + * + * @var LogDeliveryConfigurationStatus::*|null */ private $status; /** * Returns an error message for the log delivery configuration. + * + * @var string|null */ private $message; diff --git a/src/Service/ElastiCache/src/ValueObject/NotificationConfiguration.php b/src/Service/ElastiCache/src/ValueObject/NotificationConfiguration.php index 67e5ca156..fd57b4696 100644 --- a/src/Service/ElastiCache/src/ValueObject/NotificationConfiguration.php +++ b/src/Service/ElastiCache/src/ValueObject/NotificationConfiguration.php @@ -10,11 +10,15 @@ final class NotificationConfiguration { /** * The Amazon Resource Name (ARN) that identifies the topic. + * + * @var string|null */ private $topicArn; /** * The current state of the topic. + * + * @var string|null */ private $topicStatus; diff --git a/src/Service/ElastiCache/src/ValueObject/PendingLogDeliveryConfiguration.php b/src/Service/ElastiCache/src/ValueObject/PendingLogDeliveryConfiguration.php index c5732da4f..b1c92f974 100644 --- a/src/Service/ElastiCache/src/ValueObject/PendingLogDeliveryConfiguration.php +++ b/src/Service/ElastiCache/src/ValueObject/PendingLogDeliveryConfiguration.php @@ -15,21 +15,29 @@ final class PendingLogDeliveryConfiguration * Refers to slow-log [^1] or engine-log.. * * [^1]: https://redis.io/commands/slowlog + * + * @var LogType::*|null */ private $logType; /** * Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose. + * + * @var DestinationType::*|null */ private $destinationType; /** * Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. + * + * @var DestinationDetails|null */ private $destinationDetails; /** * Returns the log format, either JSON or TEXT. + * + * @var LogFormat::*|null */ private $logFormat; diff --git a/src/Service/ElastiCache/src/ValueObject/PendingModifiedValues.php b/src/Service/ElastiCache/src/ValueObject/PendingModifiedValues.php index 8ebaa2bec..0dabd21b6 100644 --- a/src/Service/ElastiCache/src/ValueObject/PendingModifiedValues.php +++ b/src/Service/ElastiCache/src/ValueObject/PendingModifiedValues.php @@ -15,42 +15,58 @@ final class PendingModifiedValues * * For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and * 40. + * + * @var int|null */ private $numCacheNodes; /** * A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric * identifier (0001, 0002, etc.). + * + * @var string[]|null */ private $cacheNodeIdsToRemove; /** * The new cache engine version that the cluster runs. + * + * @var string|null */ private $engineVersion; /** * The cache node type that this cluster or replication group is scaled to. + * + * @var string|null */ private $cacheNodeType; /** * The auth token status. + * + * @var AuthTokenUpdateStatus::*|null */ private $authTokenStatus; /** * The log delivery configurations being modified. + * + * @var PendingLogDeliveryConfiguration[]|null */ private $logDeliveryConfigurations; /** * A flag that enables in-transit encryption when set to true. + * + * @var bool|null */ private $transitEncryptionEnabled; /** * A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. + * + * @var TransitEncryptionMode::*|null */ private $transitEncryptionMode; diff --git a/src/Service/ElastiCache/src/ValueObject/SecurityGroupMembership.php b/src/Service/ElastiCache/src/ValueObject/SecurityGroupMembership.php index 2dc8b6ada..8c31adf1f 100644 --- a/src/Service/ElastiCache/src/ValueObject/SecurityGroupMembership.php +++ b/src/Service/ElastiCache/src/ValueObject/SecurityGroupMembership.php @@ -9,12 +9,16 @@ final class SecurityGroupMembership { /** * The identifier of the cache security group. + * + * @var string|null */ private $securityGroupId; /** * The status of the cache security group membership. The status changes whenever a cache security group is modified, or * when the cache security groups assigned to a cluster are modified. + * + * @var string|null */ private $status; diff --git a/src/Service/EventBridge/src/Result/PutEventsResponse.php b/src/Service/EventBridge/src/Result/PutEventsResponse.php index 7a02f5c5c..ac327b1f8 100644 --- a/src/Service/EventBridge/src/Result/PutEventsResponse.php +++ b/src/Service/EventBridge/src/Result/PutEventsResponse.php @@ -10,6 +10,8 @@ class PutEventsResponse extends Result { /** * The number of failed entries. + * + * @var int|null */ private $failedEntryCount; @@ -18,6 +20,8 @@ class PutEventsResponse extends Result * ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry. * * For each record, the index of the response element is the same as the index in the request array. + * + * @var PutEventsResultEntry[] */ private $entries; diff --git a/src/Service/EventBridge/src/ValueObject/PutEventsRequestEntry.php b/src/Service/EventBridge/src/ValueObject/PutEventsRequestEntry.php index 1ff37349d..e7c06c6e5 100644 --- a/src/Service/EventBridge/src/ValueObject/PutEventsRequestEntry.php +++ b/src/Service/EventBridge/src/ValueObject/PutEventsRequestEntry.php @@ -13,27 +13,37 @@ final class PutEventsRequestEntry * * [^1]: https://www.rfc-editor.org/rfc/rfc3339.txt * [^2]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html + * + * @var \DateTimeImmutable|null */ private $time; /** * The source of the event. + * + * @var string|null */ private $source; /** * Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any * number, including zero, may be present. + * + * @var string[]|null */ private $resources; /** * Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. + * + * @var string|null */ private $detailType; /** * A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested subobjects. + * + * @var string|null */ private $detail; @@ -44,6 +54,8 @@ final class PutEventsRequestEntry * > If you're using a global endpoint with a custom bus, you must enter the name, not the ARN, of the event bus in * > either the primary or secondary Region here and the corresponding event bus in the other Region will be determined * > based on the endpoint referenced by the `EndpointId`. + * + * @var string|null */ private $eventBusName; @@ -54,6 +66,8 @@ final class PutEventsRequestEntry * To learn more about X-Ray trace headers, see Tracing header [^1] in the X-Ray Developer Guide. * * [^1]: https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader + * + * @var string|null */ private $traceHeader; diff --git a/src/Service/EventBridge/src/ValueObject/PutEventsResultEntry.php b/src/Service/EventBridge/src/ValueObject/PutEventsResultEntry.php index 0fe189e18..fa57d2243 100644 --- a/src/Service/EventBridge/src/ValueObject/PutEventsResultEntry.php +++ b/src/Service/EventBridge/src/ValueObject/PutEventsResultEntry.php @@ -12,16 +12,22 @@ final class PutEventsResultEntry { /** * The ID of the event. + * + * @var string|null */ private $eventId; /** * The error code that indicates why the event submission failed. + * + * @var string|null */ private $errorCode; /** * The error message that explains why the event submission failed. + * + * @var string|null */ private $errorMessage; diff --git a/src/Service/Firehose/src/Result/PutRecordBatchOutput.php b/src/Service/Firehose/src/Result/PutRecordBatchOutput.php index d962bb769..6db230f26 100644 --- a/src/Service/Firehose/src/Result/PutRecordBatchOutput.php +++ b/src/Service/Firehose/src/Result/PutRecordBatchOutput.php @@ -11,17 +11,23 @@ class PutRecordBatchOutput extends Result /** * The number of records that might have failed processing. This number might be greater than 0 even if the * PutRecordBatch call succeeds. Check `FailedPutCount` to determine whether there are records that you need to resend. + * + * @var int */ private $failedPutCount; /** * Indicates whether server-side encryption (SSE) was enabled during this operation. + * + * @var bool|null */ private $encrypted; /** * The results array. For each record, the index of the response element is the same as the index used in the request * array. + * + * @var PutRecordBatchResponseEntry[] */ private $requestResponses; diff --git a/src/Service/Firehose/src/Result/PutRecordOutput.php b/src/Service/Firehose/src/Result/PutRecordOutput.php index ed95ce5e7..4a872c96c 100644 --- a/src/Service/Firehose/src/Result/PutRecordOutput.php +++ b/src/Service/Firehose/src/Result/PutRecordOutput.php @@ -9,11 +9,15 @@ class PutRecordOutput extends Result { /** * The ID of the record. + * + * @var string */ private $recordId; /** * Indicates whether server-side encryption (SSE) was enabled during this operation. + * + * @var bool|null */ private $encrypted; diff --git a/src/Service/Firehose/src/ValueObject/PutRecordBatchResponseEntry.php b/src/Service/Firehose/src/ValueObject/PutRecordBatchResponseEntry.php index b19cd258b..86e4e97c3 100644 --- a/src/Service/Firehose/src/ValueObject/PutRecordBatchResponseEntry.php +++ b/src/Service/Firehose/src/ValueObject/PutRecordBatchResponseEntry.php @@ -11,16 +11,22 @@ final class PutRecordBatchResponseEntry { /** * The ID of the record. + * + * @var string|null */ private $recordId; /** * The error code for an individual record result. + * + * @var string|null */ private $errorCode; /** * The error message for an individual record result. + * + * @var string|null */ private $errorMessage; diff --git a/src/Service/Firehose/src/ValueObject/Record.php b/src/Service/Firehose/src/ValueObject/Record.php index ea9216ec2..5d61dfd89 100644 --- a/src/Service/Firehose/src/ValueObject/Record.php +++ b/src/Service/Firehose/src/ValueObject/Record.php @@ -12,6 +12,8 @@ final class Record /** * The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before * base64-encoding, is 1,000 KiB. + * + * @var string */ private $data; diff --git a/src/Service/Iam/src/Result/CreateAccessKeyResponse.php b/src/Service/Iam/src/Result/CreateAccessKeyResponse.php index 31dda9677..2fbe86686 100644 --- a/src/Service/Iam/src/Result/CreateAccessKeyResponse.php +++ b/src/Service/Iam/src/Result/CreateAccessKeyResponse.php @@ -13,6 +13,8 @@ class CreateAccessKeyResponse extends Result { /** * A structure with details about the access key. + * + * @var AccessKey */ private $accessKey; diff --git a/src/Service/Iam/src/Result/CreateServiceSpecificCredentialResponse.php b/src/Service/Iam/src/Result/CreateServiceSpecificCredentialResponse.php index ded940b0d..9663f6a5a 100644 --- a/src/Service/Iam/src/Result/CreateServiceSpecificCredentialResponse.php +++ b/src/Service/Iam/src/Result/CreateServiceSpecificCredentialResponse.php @@ -13,6 +13,8 @@ class CreateServiceSpecificCredentialResponse extends Result * * ! This is the only time that the password for this credential set is available. It cannot be recovered later. * ! Instead, you must reset the password with ResetServiceSpecificCredential. + * + * @var ServiceSpecificCredential|null */ private $serviceSpecificCredential; diff --git a/src/Service/Iam/src/Result/CreateUserResponse.php b/src/Service/Iam/src/Result/CreateUserResponse.php index 8de1fbdff..d2e69a1ed 100644 --- a/src/Service/Iam/src/Result/CreateUserResponse.php +++ b/src/Service/Iam/src/Result/CreateUserResponse.php @@ -15,6 +15,8 @@ class CreateUserResponse extends Result { /** * A structure with details about the new IAM user. + * + * @var User|null */ private $user; diff --git a/src/Service/Iam/src/Result/GetUserResponse.php b/src/Service/Iam/src/Result/GetUserResponse.php index 0f16b1b37..dc1ace41a 100644 --- a/src/Service/Iam/src/Result/GetUserResponse.php +++ b/src/Service/Iam/src/Result/GetUserResponse.php @@ -30,6 +30,8 @@ class GetUserResponse extends Result * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_finding-unused.html * [^2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html + * + * @var User */ private $user; diff --git a/src/Service/Iam/src/Result/ListServiceSpecificCredentialsResponse.php b/src/Service/Iam/src/Result/ListServiceSpecificCredentialsResponse.php index 9931ea845..d9e1f7e2f 100644 --- a/src/Service/Iam/src/Result/ListServiceSpecificCredentialsResponse.php +++ b/src/Service/Iam/src/Result/ListServiceSpecificCredentialsResponse.php @@ -10,6 +10,8 @@ class ListServiceSpecificCredentialsResponse extends Result { /** * A list of structures that each contain details about a service-specific credential. + * + * @var ServiceSpecificCredentialMetadata[] */ private $serviceSpecificCredentials; diff --git a/src/Service/Iam/src/Result/ListUsersResponse.php b/src/Service/Iam/src/Result/ListUsersResponse.php index 06a4e4501..bcbbf61b9 100644 --- a/src/Service/Iam/src/Result/ListUsersResponse.php +++ b/src/Service/Iam/src/Result/ListUsersResponse.php @@ -20,6 +20,8 @@ class ListUsersResponse extends Result implements \IteratorAggregate { /** * A list of users. + * + * @var User[] */ private $users; @@ -28,12 +30,16 @@ class ListUsersResponse extends Result implements \IteratorAggregate * subsequent pagination request using the `Marker` request parameter to retrieve more items. Note that IAM might return * fewer than the `MaxItems` number of results even when there are more results available. We recommend that you check * `IsTruncated` after every call to ensure that you receive all your results. + * + * @var bool|null */ private $isTruncated; /** * When `IsTruncated` is `true`, this element is present and contains the value to use for the `Marker` parameter in a * subsequent pagination request. + * + * @var string|null */ private $marker; diff --git a/src/Service/Iam/src/ValueObject/AccessKey.php b/src/Service/Iam/src/ValueObject/AccessKey.php index 2ed20a753..629c5fc91 100644 --- a/src/Service/Iam/src/ValueObject/AccessKey.php +++ b/src/Service/Iam/src/ValueObject/AccessKey.php @@ -18,26 +18,36 @@ final class AccessKey { /** * The name of the IAM user that the access key is associated with. + * + * @var string */ private $userName; /** * The ID for this access key. + * + * @var string */ private $accessKeyId; /** * The status of the access key. `Active` means that the key is valid for API calls, while `Inactive` means it is not. + * + * @var StatusType::* */ private $status; /** * The secret key used to sign requests. + * + * @var string */ private $secretAccessKey; /** * The date when the access key was created. + * + * @var \DateTimeImmutable|null */ private $createDate; diff --git a/src/Service/Iam/src/ValueObject/AttachedPermissionsBoundary.php b/src/Service/Iam/src/ValueObject/AttachedPermissionsBoundary.php index 29f4498d1..dbbe9478f 100644 --- a/src/Service/Iam/src/ValueObject/AttachedPermissionsBoundary.php +++ b/src/Service/Iam/src/ValueObject/AttachedPermissionsBoundary.php @@ -20,11 +20,15 @@ final class AttachedPermissionsBoundary /** * The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for * an entity. This data type can only have a value of `Policy`. + * + * @var PermissionsBoundaryAttachmentType::*|null */ private $permissionsBoundaryType; /** * The ARN of the policy used to set the permissions boundary for the user or role. + * + * @var string|null */ private $permissionsBoundaryArn; diff --git a/src/Service/Iam/src/ValueObject/ServiceSpecificCredential.php b/src/Service/Iam/src/ValueObject/ServiceSpecificCredential.php index 8c929222a..89355491d 100644 --- a/src/Service/Iam/src/ValueObject/ServiceSpecificCredential.php +++ b/src/Service/Iam/src/ValueObject/ServiceSpecificCredential.php @@ -14,11 +14,15 @@ final class ServiceSpecificCredential * The date and time, in ISO 8601 date-time format [^1], when the service-specific credential were created. * * [^1]: http://www.iso.org/iso/iso8601 + * + * @var \DateTimeImmutable */ private $createDate; /** * The name of the service associated with the service-specific credential. + * + * @var string */ private $serviceName; @@ -26,27 +30,37 @@ final class ServiceSpecificCredential * The generated user name for the service-specific credential. This value is generated by combining the IAM user's name * combined with the ID number of the Amazon Web Services account, as in `jane-at-123456789012`, for example. This value * cannot be configured by the user. + * + * @var string */ private $serviceUserName; /** * The generated password for the service-specific credential. + * + * @var string */ private $servicePassword; /** * The unique identifier for the service-specific credential. + * + * @var string */ private $serviceSpecificCredentialId; /** * The name of the IAM user associated with the service-specific credential. + * + * @var string */ private $userName; /** * The status of the service-specific credential. `Active` means that the key is valid for API calls, while `Inactive` * means it is not. + * + * @var StatusType::* */ private $status; diff --git a/src/Service/Iam/src/ValueObject/ServiceSpecificCredentialMetadata.php b/src/Service/Iam/src/ValueObject/ServiceSpecificCredentialMetadata.php index c001b3400..d45e307b2 100644 --- a/src/Service/Iam/src/ValueObject/ServiceSpecificCredentialMetadata.php +++ b/src/Service/Iam/src/ValueObject/ServiceSpecificCredentialMetadata.php @@ -12,17 +12,23 @@ final class ServiceSpecificCredentialMetadata { /** * The name of the IAM user associated with the service-specific credential. + * + * @var string */ private $userName; /** * The status of the service-specific credential. `Active` means that the key is valid for API calls, while `Inactive` * means it is not. + * + * @var StatusType::* */ private $status; /** * The generated user name for the service-specific credential. + * + * @var string */ private $serviceUserName; @@ -30,16 +36,22 @@ final class ServiceSpecificCredentialMetadata * The date and time, in ISO 8601 date-time format [^1], when the service-specific credential were created. * * [^1]: http://www.iso.org/iso/iso8601 + * + * @var \DateTimeImmutable */ private $createDate; /** * The unique identifier for the service-specific credential. + * + * @var string */ private $serviceSpecificCredentialId; /** * The name of the service associated with the service-specific credential. + * + * @var string */ private $serviceName; diff --git a/src/Service/Iam/src/ValueObject/Tag.php b/src/Service/Iam/src/ValueObject/Tag.php index 9b4acd343..059157c68 100644 --- a/src/Service/Iam/src/ValueObject/Tag.php +++ b/src/Service/Iam/src/ValueObject/Tag.php @@ -15,6 +15,8 @@ final class Tag /** * The key name that can be used to look up or retrieve the associated value. For example, `Department` or `Cost Center` * are common choices. + * + * @var string */ private $key; @@ -26,6 +28,8 @@ final class Tag * * > Amazon Web Services always interprets the tag `Value` as a single string. If you need to store an array, you can * > store comma-separated values in the string. However, you must interpret the value in your code. + * + * @var string */ private $value; diff --git a/src/Service/Iam/src/ValueObject/User.php b/src/Service/Iam/src/ValueObject/User.php index b0deaa705..26e425bd6 100644 --- a/src/Service/Iam/src/ValueObject/User.php +++ b/src/Service/Iam/src/ValueObject/User.php @@ -21,11 +21,15 @@ final class User * The ARN of the policy used to set the permissions boundary for the user. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + * + * @var string */ private $path; /** * The friendly name identifying the user. + * + * @var string */ private $userName; @@ -34,6 +38,8 @@ final class User * *IAM User Guide*. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + * + * @var string */ private $userId; @@ -42,6 +48,8 @@ final class User * policies, see IAM Identifiers [^1] in the *IAM User Guide*. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + * + * @var string */ private $arn; @@ -49,6 +57,8 @@ final class User * The date and time, in ISO 8601 date-time format [^1], when the user was created. * * [^1]: http://www.iso.org/iso/iso8601 + * + * @var \DateTimeImmutable */ private $createDate; @@ -69,6 +79,8 @@ final class User * * [^1]: http://www.iso.org/iso/iso8601 * [^2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html + * + * @var \DateTimeImmutable|null */ private $passwordLastUsed; @@ -77,6 +89,8 @@ final class User * User Guide*. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html + * + * @var AttachedPermissionsBoundary|null */ private $permissionsBoundary; @@ -85,6 +99,8 @@ final class User * in the *IAM User Guide*. * * [^1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html + * + * @var Tag[]|null */ private $tags; diff --git a/src/Service/Iot/src/Exception/ResourceAlreadyExistsException.php b/src/Service/Iot/src/Exception/ResourceAlreadyExistsException.php index becf6e029..99fec7999 100644 --- a/src/Service/Iot/src/Exception/ResourceAlreadyExistsException.php +++ b/src/Service/Iot/src/Exception/ResourceAlreadyExistsException.php @@ -12,11 +12,15 @@ final class ResourceAlreadyExistsException extends ClientException { /** * The ID of the resource that caused the exception. + * + * @var string|null */ private $resourceId; /** * The ARN of the resource that caused the exception. + * + * @var string|null */ private $resourceArn; diff --git a/src/Service/Iot/src/Result/CreateThingGroupResponse.php b/src/Service/Iot/src/Result/CreateThingGroupResponse.php index d90edc236..dd9975c4d 100644 --- a/src/Service/Iot/src/Result/CreateThingGroupResponse.php +++ b/src/Service/Iot/src/Result/CreateThingGroupResponse.php @@ -9,16 +9,22 @@ class CreateThingGroupResponse extends Result { /** * The thing group name. + * + * @var string|null */ private $thingGroupName; /** * The thing group ARN. + * + * @var string|null */ private $thingGroupArn; /** * The thing group ID. + * + * @var string|null */ private $thingGroupId; diff --git a/src/Service/Iot/src/Result/CreateThingResponse.php b/src/Service/Iot/src/Result/CreateThingResponse.php index dee0123cb..286b5920d 100644 --- a/src/Service/Iot/src/Result/CreateThingResponse.php +++ b/src/Service/Iot/src/Result/CreateThingResponse.php @@ -12,16 +12,22 @@ class CreateThingResponse extends Result { /** * The name of the new thing. + * + * @var string|null */ private $thingName; /** * The ARN of the new thing. + * + * @var string|null */ private $thingArn; /** * The thing ID. + * + * @var string|null */ private $thingId; diff --git a/src/Service/Iot/src/Result/CreateThingTypeResponse.php b/src/Service/Iot/src/Result/CreateThingTypeResponse.php index 028872895..172f24583 100644 --- a/src/Service/Iot/src/Result/CreateThingTypeResponse.php +++ b/src/Service/Iot/src/Result/CreateThingTypeResponse.php @@ -12,16 +12,22 @@ class CreateThingTypeResponse extends Result { /** * The name of the thing type. + * + * @var string|null */ private $thingTypeName; /** * The Amazon Resource Name (ARN) of the thing type. + * + * @var string|null */ private $thingTypeArn; /** * The thing type ID. + * + * @var string|null */ private $thingTypeId; diff --git a/src/Service/Iot/src/Result/ListThingGroupsForThingResponse.php b/src/Service/Iot/src/Result/ListThingGroupsForThingResponse.php index ae7c0bb04..3b137fb9b 100644 --- a/src/Service/Iot/src/Result/ListThingGroupsForThingResponse.php +++ b/src/Service/Iot/src/Result/ListThingGroupsForThingResponse.php @@ -16,11 +16,15 @@ class ListThingGroupsForThingResponse extends Result implements \IteratorAggrega { /** * The thing groups. + * + * @var GroupNameAndArn[] */ private $thingGroups; /** * The token to use to get the next set of results, or **null** if there are no additional results. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Iot/src/Result/ListThingGroupsResponse.php b/src/Service/Iot/src/Result/ListThingGroupsResponse.php index fc19b9a6c..95d7c0fa2 100644 --- a/src/Service/Iot/src/Result/ListThingGroupsResponse.php +++ b/src/Service/Iot/src/Result/ListThingGroupsResponse.php @@ -16,11 +16,15 @@ class ListThingGroupsResponse extends Result implements \IteratorAggregate { /** * The thing groups. + * + * @var GroupNameAndArn[] */ private $thingGroups; /** * The token to use to get the next set of results. Will not be returned if operation has returned all results. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Iot/src/Result/ListThingTypesResponse.php b/src/Service/Iot/src/Result/ListThingTypesResponse.php index e5ba44b37..32dda9a0f 100644 --- a/src/Service/Iot/src/Result/ListThingTypesResponse.php +++ b/src/Service/Iot/src/Result/ListThingTypesResponse.php @@ -20,11 +20,15 @@ class ListThingTypesResponse extends Result implements \IteratorAggregate { /** * The thing types. + * + * @var ThingTypeDefinition[] */ private $thingTypes; /** * The token for the next set of results. Will not be returned if operation has returned all results. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Iot/src/Result/ListThingsInThingGroupResponse.php b/src/Service/Iot/src/Result/ListThingsInThingGroupResponse.php index 60c1d1f7f..14bb3f940 100644 --- a/src/Service/Iot/src/Result/ListThingsInThingGroupResponse.php +++ b/src/Service/Iot/src/Result/ListThingsInThingGroupResponse.php @@ -15,11 +15,15 @@ class ListThingsInThingGroupResponse extends Result implements \IteratorAggregat { /** * The things in the specified thing group. + * + * @var string[] */ private $things; /** * The token to use to get the next set of results, or **null** if there are no additional results. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Iot/src/Result/ListThingsResponse.php b/src/Service/Iot/src/Result/ListThingsResponse.php index 747faa1b2..254c6ccdc 100644 --- a/src/Service/Iot/src/Result/ListThingsResponse.php +++ b/src/Service/Iot/src/Result/ListThingsResponse.php @@ -18,11 +18,15 @@ class ListThingsResponse extends Result implements \IteratorAggregate { /** * The things. + * + * @var ThingAttribute[] */ private $things; /** * The token to use to get the next set of results. Will not be returned if operation has returned all results. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Iot/src/ValueObject/AttributePayload.php b/src/Service/Iot/src/ValueObject/AttributePayload.php index fa78abb58..986ae9453 100644 --- a/src/Service/Iot/src/ValueObject/AttributePayload.php +++ b/src/Service/Iot/src/ValueObject/AttributePayload.php @@ -11,6 +11,8 @@ final class AttributePayload * A JSON string containing up to three key-value pair in JSON format. For example:. * * `{\"attributes\":{\"string1\":\"string2\"}}` + * + * @var array|null */ private $attributes; @@ -21,6 +23,8 @@ final class AttributePayload * To remove an attribute, call `UpdateThing` with an empty attribute value. * * > The `merge` attribute is only valid when calling `UpdateThing` or `UpdateThingGroup`. + * + * @var bool|null */ private $merge; diff --git a/src/Service/Iot/src/ValueObject/GroupNameAndArn.php b/src/Service/Iot/src/ValueObject/GroupNameAndArn.php index 3834ff1de..97e344755 100644 --- a/src/Service/Iot/src/ValueObject/GroupNameAndArn.php +++ b/src/Service/Iot/src/ValueObject/GroupNameAndArn.php @@ -9,11 +9,15 @@ final class GroupNameAndArn { /** * The group name. + * + * @var string|null */ private $groupName; /** * The group ARN. + * + * @var string|null */ private $groupArn; diff --git a/src/Service/Iot/src/ValueObject/Tag.php b/src/Service/Iot/src/ValueObject/Tag.php index cbfd3ec43..30af5f6f0 100644 --- a/src/Service/Iot/src/ValueObject/Tag.php +++ b/src/Service/Iot/src/ValueObject/Tag.php @@ -11,11 +11,15 @@ final class Tag { /** * The tag's key. + * + * @var string */ private $key; /** * The tag's value. + * + * @var string|null */ private $value; diff --git a/src/Service/Iot/src/ValueObject/ThingAttribute.php b/src/Service/Iot/src/ValueObject/ThingAttribute.php index 17327a41e..d15cd2277 100644 --- a/src/Service/Iot/src/ValueObject/ThingAttribute.php +++ b/src/Service/Iot/src/ValueObject/ThingAttribute.php @@ -9,26 +9,36 @@ final class ThingAttribute { /** * The name of the thing. + * + * @var string|null */ private $thingName; /** * The name of the thing type, if the thing has been associated with a type. + * + * @var string|null */ private $thingTypeName; /** * The thing ARN. + * + * @var string|null */ private $thingArn; /** * A list of thing attributes which are name-value pairs. + * + * @var array|null */ private $attributes; /** * The version of the thing record in the registry. + * + * @var int|null */ private $version; diff --git a/src/Service/Iot/src/ValueObject/ThingGroupProperties.php b/src/Service/Iot/src/ValueObject/ThingGroupProperties.php index 27f238ff2..69c55ae98 100644 --- a/src/Service/Iot/src/ValueObject/ThingGroupProperties.php +++ b/src/Service/Iot/src/ValueObject/ThingGroupProperties.php @@ -9,11 +9,15 @@ final class ThingGroupProperties { /** * The thing group description. + * + * @var string|null */ private $thingGroupDescription; /** * The thing group attributes in JSON format. + * + * @var AttributePayload|null */ private $attributePayload; diff --git a/src/Service/Iot/src/ValueObject/ThingTypeDefinition.php b/src/Service/Iot/src/ValueObject/ThingTypeDefinition.php index dc0b72d0d..80d842755 100644 --- a/src/Service/Iot/src/ValueObject/ThingTypeDefinition.php +++ b/src/Service/Iot/src/ValueObject/ThingTypeDefinition.php @@ -9,22 +9,30 @@ final class ThingTypeDefinition { /** * The name of the thing type. + * + * @var string|null */ private $thingTypeName; /** * The thing type ARN. + * + * @var string|null */ private $thingTypeArn; /** * The ThingTypeProperties for the thing type. + * + * @var ThingTypeProperties|null */ private $thingTypeProperties; /** * The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value * indicating whether the thing type is deprecated, and a date and time when it was deprecated. + * + * @var ThingTypeMetadata|null */ private $thingTypeMetadata; diff --git a/src/Service/Iot/src/ValueObject/ThingTypeMetadata.php b/src/Service/Iot/src/ValueObject/ThingTypeMetadata.php index 394655d32..700f19f51 100644 --- a/src/Service/Iot/src/ValueObject/ThingTypeMetadata.php +++ b/src/Service/Iot/src/ValueObject/ThingTypeMetadata.php @@ -10,16 +10,22 @@ final class ThingTypeMetadata { /** * Whether the thing type is deprecated. If **true**, no new things could be associated with this type. + * + * @var bool|null */ private $deprecated; /** * The date and time when the thing type was deprecated. + * + * @var \DateTimeImmutable|null */ private $deprecationDate; /** * The date and time when the thing type was created. + * + * @var \DateTimeImmutable|null */ private $creationDate; diff --git a/src/Service/Iot/src/ValueObject/ThingTypeProperties.php b/src/Service/Iot/src/ValueObject/ThingTypeProperties.php index 770efd00b..286cd7805 100644 --- a/src/Service/Iot/src/ValueObject/ThingTypeProperties.php +++ b/src/Service/Iot/src/ValueObject/ThingTypeProperties.php @@ -10,11 +10,15 @@ final class ThingTypeProperties { /** * The description of the thing type. + * + * @var string|null */ private $thingTypeDescription; /** * A list of searchable thing attribute names. + * + * @var string[]|null */ private $searchableAttributes; diff --git a/src/Service/IotData/src/Result/GetThingShadowResponse.php b/src/Service/IotData/src/Result/GetThingShadowResponse.php index dbcca0c29..c24f2dadc 100644 --- a/src/Service/IotData/src/Result/GetThingShadowResponse.php +++ b/src/Service/IotData/src/Result/GetThingShadowResponse.php @@ -12,6 +12,8 @@ class GetThingShadowResponse extends Result { /** * The state information, in JSON format. + * + * @var string|null */ private $payload; diff --git a/src/Service/IotData/src/Result/UpdateThingShadowResponse.php b/src/Service/IotData/src/Result/UpdateThingShadowResponse.php index 3d551e0d9..64e6ae3f6 100644 --- a/src/Service/IotData/src/Result/UpdateThingShadowResponse.php +++ b/src/Service/IotData/src/Result/UpdateThingShadowResponse.php @@ -12,6 +12,8 @@ class UpdateThingShadowResponse extends Result { /** * The state information, in JSON format. + * + * @var string|null */ private $payload; diff --git a/src/Service/Kinesis/src/Result/DescribeLimitsOutput.php b/src/Service/Kinesis/src/Result/DescribeLimitsOutput.php index 7b68641a5..1d1331bbe 100644 --- a/src/Service/Kinesis/src/Result/DescribeLimitsOutput.php +++ b/src/Service/Kinesis/src/Result/DescribeLimitsOutput.php @@ -9,21 +9,29 @@ class DescribeLimitsOutput extends Result { /** * The maximum number of shards. + * + * @var int */ private $shardLimit; /** * The number of open shards. + * + * @var int */ private $openShardCount; /** * Indicates the number of data streams with the on-demand capacity mode. + * + * @var int */ private $onDemandStreamCount; /** * The maximum number of data streams with the on-demand capacity mode. + * + * @var int */ private $onDemandStreamCountLimit; diff --git a/src/Service/Kinesis/src/Result/DescribeStreamConsumerOutput.php b/src/Service/Kinesis/src/Result/DescribeStreamConsumerOutput.php index 0b251d1ee..c3359baad 100644 --- a/src/Service/Kinesis/src/Result/DescribeStreamConsumerOutput.php +++ b/src/Service/Kinesis/src/Result/DescribeStreamConsumerOutput.php @@ -10,6 +10,8 @@ class DescribeStreamConsumerOutput extends Result { /** * An object that represents the details of the consumer. + * + * @var ConsumerDescription */ private $consumerDescription; diff --git a/src/Service/Kinesis/src/Result/DescribeStreamOutput.php b/src/Service/Kinesis/src/Result/DescribeStreamOutput.php index aa52d34ea..91d4f64fc 100644 --- a/src/Service/Kinesis/src/Result/DescribeStreamOutput.php +++ b/src/Service/Kinesis/src/Result/DescribeStreamOutput.php @@ -25,6 +25,8 @@ class DescribeStreamOutput extends Result implements \IteratorAggregate /** * The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the * stream, and whether there are more shards available. + * + * @var StreamDescription */ private $streamDescription; diff --git a/src/Service/Kinesis/src/Result/DescribeStreamSummaryOutput.php b/src/Service/Kinesis/src/Result/DescribeStreamSummaryOutput.php index 22fd94917..84e00638b 100644 --- a/src/Service/Kinesis/src/Result/DescribeStreamSummaryOutput.php +++ b/src/Service/Kinesis/src/Result/DescribeStreamSummaryOutput.php @@ -13,6 +13,8 @@ class DescribeStreamSummaryOutput extends Result { /** * A StreamDescriptionSummary containing information about the stream. + * + * @var StreamDescriptionSummary */ private $streamDescriptionSummary; diff --git a/src/Service/Kinesis/src/Result/EnhancedMonitoringOutput.php b/src/Service/Kinesis/src/Result/EnhancedMonitoringOutput.php index 54be140d5..627199537 100644 --- a/src/Service/Kinesis/src/Result/EnhancedMonitoringOutput.php +++ b/src/Service/Kinesis/src/Result/EnhancedMonitoringOutput.php @@ -13,21 +13,29 @@ class EnhancedMonitoringOutput extends Result { /** * The name of the Kinesis data stream. + * + * @var string|null */ private $streamName; /** * Represents the current state of the metrics that are in the enhanced state before the operation. + * + * @var list */ private $currentShardLevelMetrics; /** * Represents the list of all the metrics that would be in the enhanced state after the operation. + * + * @var list */ private $desiredShardLevelMetrics; /** * The ARN of the stream. + * + * @var string|null */ private $streamArn; diff --git a/src/Service/Kinesis/src/Result/GetRecordsOutput.php b/src/Service/Kinesis/src/Result/GetRecordsOutput.php index a9eed2049..518dd0316 100644 --- a/src/Service/Kinesis/src/Result/GetRecordsOutput.php +++ b/src/Service/Kinesis/src/Result/GetRecordsOutput.php @@ -15,12 +15,16 @@ class GetRecordsOutput extends Result { /** * The data records retrieved from the shard. + * + * @var Record[] */ private $records; /** * The next position in the shard from which to start sequentially reading data records. If set to `null`, the shard has * been closed and the requested iterator does not return any more data. + * + * @var string|null */ private $nextShardIterator; @@ -28,12 +32,16 @@ class GetRecordsOutput extends Result * The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current * time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to * process at this moment. + * + * @var int|null */ private $millisBehindLatest; /** * The list of the current shard's child shards, returned in the `GetRecords` API's response only when the end of the * current shard is reached. + * + * @var ChildShard[] */ private $childShards; diff --git a/src/Service/Kinesis/src/Result/GetShardIteratorOutput.php b/src/Service/Kinesis/src/Result/GetShardIteratorOutput.php index b4cfb3df8..f588308f7 100644 --- a/src/Service/Kinesis/src/Result/GetShardIteratorOutput.php +++ b/src/Service/Kinesis/src/Result/GetShardIteratorOutput.php @@ -13,6 +13,8 @@ class GetShardIteratorOutput extends Result /** * The position in the shard from which to start reading data records sequentially. A shard iterator specifies this * position using the sequence number of a data record in a shard. + * + * @var string|null */ private $shardIterator; diff --git a/src/Service/Kinesis/src/Result/ListShardsOutput.php b/src/Service/Kinesis/src/Result/ListShardsOutput.php index ff9c78140..cc1fea666 100644 --- a/src/Service/Kinesis/src/Result/ListShardsOutput.php +++ b/src/Service/Kinesis/src/Result/ListShardsOutput.php @@ -14,6 +14,8 @@ class ListShardsOutput extends Result * An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, * and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and * the starting and ending sequence numbers for the shard. + * + * @var Shard[] */ private $shards; @@ -27,6 +29,8 @@ class ListShardsOutput extends Result * ! Tokens expire after 300 seconds. When you obtain a value for `NextToken` in the response to a call to `ListShards`, * ! you have 300 seconds to use that value. If you specify an expired token in a call to `ListShards`, you get * ! `ExpiredNextTokenException`. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Kinesis/src/Result/ListStreamConsumersOutput.php b/src/Service/Kinesis/src/Result/ListStreamConsumersOutput.php index 51830a442..d3fd2a404 100644 --- a/src/Service/Kinesis/src/Result/ListStreamConsumersOutput.php +++ b/src/Service/Kinesis/src/Result/ListStreamConsumersOutput.php @@ -16,6 +16,8 @@ class ListStreamConsumersOutput extends Result implements \IteratorAggregate { /** * An array of JSON objects. Each object represents one registered consumer. + * + * @var Consumer[] */ private $consumers; @@ -30,6 +32,8 @@ class ListStreamConsumersOutput extends Result implements \IteratorAggregate * ! Tokens expire after 300 seconds. When you obtain a value for `NextToken` in the response to a call to * ! `ListStreamConsumers`, you have 300 seconds to use that value. If you specify an expired token in a call to * ! `ListStreamConsumers`, you get `ExpiredNextTokenException`. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Kinesis/src/Result/ListStreamsOutput.php b/src/Service/Kinesis/src/Result/ListStreamsOutput.php index b026ca7f6..95d25397a 100644 --- a/src/Service/Kinesis/src/Result/ListStreamsOutput.php +++ b/src/Service/Kinesis/src/Result/ListStreamsOutput.php @@ -19,16 +19,26 @@ class ListStreamsOutput extends Result implements \IteratorAggregate { /** * The names of the streams that are associated with the Amazon Web Services account making the `ListStreams` request. + * + * @var string[] */ private $streamNames; /** * If set to `true`, there are more streams available to list. + * + * @var bool */ private $hasMoreStreams; + /** + * @var string|null + */ private $nextToken; + /** + * @var StreamSummary[] + */ private $streamSummaries; public function getHasMoreStreams(): bool diff --git a/src/Service/Kinesis/src/Result/ListTagsForStreamOutput.php b/src/Service/Kinesis/src/Result/ListTagsForStreamOutput.php index ff47ab592..c63a8b975 100644 --- a/src/Service/Kinesis/src/Result/ListTagsForStreamOutput.php +++ b/src/Service/Kinesis/src/Result/ListTagsForStreamOutput.php @@ -14,12 +14,16 @@ class ListTagsForStreamOutput extends Result /** * A list of tags associated with `StreamName`, starting with the first tag after `ExclusiveStartTagKey` and up to the * specified `Limit`. + * + * @var Tag[] */ private $tags; /** * If set to `true`, more tags are available. To request additional tags, set `ExclusiveStartTagKey` to the key of the * last tag returned. + * + * @var bool */ private $hasMoreTags; diff --git a/src/Service/Kinesis/src/Result/PutRecordOutput.php b/src/Service/Kinesis/src/Result/PutRecordOutput.php index c175b6aae..0b77e536f 100644 --- a/src/Service/Kinesis/src/Result/PutRecordOutput.php +++ b/src/Service/Kinesis/src/Result/PutRecordOutput.php @@ -13,6 +13,8 @@ class PutRecordOutput extends Result { /** * The shard ID of the shard where the data record was placed. + * + * @var string */ private $shardId; @@ -20,6 +22,8 @@ class PutRecordOutput extends Result * The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique * across all records in the stream. A sequence number is the identifier associated with every record put into the * stream. + * + * @var string */ private $sequenceNumber; @@ -29,6 +33,8 @@ class PutRecordOutput extends Result * - `NONE`: Do not encrypt the records in the stream. * - `KMS`: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS * key. + * + * @var EncryptionType::*|null */ private $encryptionType; diff --git a/src/Service/Kinesis/src/Result/PutRecordsOutput.php b/src/Service/Kinesis/src/Result/PutRecordsOutput.php index 84ac435e2..5aba1f64d 100644 --- a/src/Service/Kinesis/src/Result/PutRecordsOutput.php +++ b/src/Service/Kinesis/src/Result/PutRecordsOutput.php @@ -14,6 +14,8 @@ class PutRecordsOutput extends Result { /** * The number of unsuccessfully processed records in a `PutRecords` request. + * + * @var int|null */ private $failedRecordCount; @@ -21,6 +23,8 @@ class PutRecordsOutput extends Result * An array of successfully and unsuccessfully processed record results. A record that is successfully added to a stream * includes `SequenceNumber` and `ShardId` in the result. A record that fails to be added to a stream includes * `ErrorCode` and `ErrorMessage` in the result. + * + * @var PutRecordsResultEntry[] */ private $records; @@ -29,6 +33,8 @@ class PutRecordsOutput extends Result * * - `NONE`: Do not encrypt the records. * - `KMS`: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key. + * + * @var EncryptionType::*|null */ private $encryptionType; diff --git a/src/Service/Kinesis/src/Result/RegisterStreamConsumerOutput.php b/src/Service/Kinesis/src/Result/RegisterStreamConsumerOutput.php index 751109ba9..80f47de08 100644 --- a/src/Service/Kinesis/src/Result/RegisterStreamConsumerOutput.php +++ b/src/Service/Kinesis/src/Result/RegisterStreamConsumerOutput.php @@ -11,6 +11,8 @@ class RegisterStreamConsumerOutput extends Result /** * An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN * that is generated by Kinesis Data Streams. + * + * @var Consumer */ private $consumer; diff --git a/src/Service/Kinesis/src/Result/UpdateShardCountOutput.php b/src/Service/Kinesis/src/Result/UpdateShardCountOutput.php index d6d58b93f..51e74a7cc 100644 --- a/src/Service/Kinesis/src/Result/UpdateShardCountOutput.php +++ b/src/Service/Kinesis/src/Result/UpdateShardCountOutput.php @@ -9,21 +9,29 @@ class UpdateShardCountOutput extends Result { /** * The name of the stream. + * + * @var string|null */ private $streamName; /** * The current number of shards. + * + * @var int|null */ private $currentShardCount; /** * The updated number of shards. + * + * @var int|null */ private $targetShardCount; /** * The ARN of the stream. + * + * @var string|null */ private $streamArn; diff --git a/src/Service/Kinesis/src/ValueObject/ChildShard.php b/src/Service/Kinesis/src/ValueObject/ChildShard.php index 65553a5be..528b7ea71 100644 --- a/src/Service/Kinesis/src/ValueObject/ChildShard.php +++ b/src/Service/Kinesis/src/ValueObject/ChildShard.php @@ -11,14 +11,21 @@ final class ChildShard { /** * The shard ID of the existing child shard of the current shard. + * + * @var string */ private $shardId; /** * The current shard that is the parent of the existing child shard. + * + * @var string[] */ private $parentShards; + /** + * @var HashKeyRange + */ private $hashKeyRange; /** diff --git a/src/Service/Kinesis/src/ValueObject/Consumer.php b/src/Service/Kinesis/src/ValueObject/Consumer.php index bcafb1b6e..c8912cfa7 100644 --- a/src/Service/Kinesis/src/ValueObject/Consumer.php +++ b/src/Service/Kinesis/src/ValueObject/Consumer.php @@ -13,6 +13,8 @@ final class Consumer { /** * The name of the consumer is something you choose when you register the consumer. + * + * @var string */ private $consumerName; @@ -23,14 +25,21 @@ final class Consumer * If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because * consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that * reference consumer ARNs. + * + * @var string */ private $consumerArn; /** * A consumer can't read data while in the `CREATING` or `DELETING` states. + * + * @var ConsumerStatus::* */ private $consumerStatus; + /** + * @var \DateTimeImmutable + */ private $consumerCreationTimestamp; /** diff --git a/src/Service/Kinesis/src/ValueObject/ConsumerDescription.php b/src/Service/Kinesis/src/ValueObject/ConsumerDescription.php index 0158ffc2d..8a5eb31f3 100644 --- a/src/Service/Kinesis/src/ValueObject/ConsumerDescription.php +++ b/src/Service/Kinesis/src/ValueObject/ConsumerDescription.php @@ -13,6 +13,8 @@ final class ConsumerDescription { /** * The name of the consumer is something you choose when you register the consumer. + * + * @var string */ private $consumerName; @@ -23,18 +25,27 @@ final class ConsumerDescription * If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because * consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that * reference consumer ARNs. + * + * @var string */ private $consumerArn; /** * A consumer can't read data while in the `CREATING` or `DELETING` states. + * + * @var ConsumerStatus::* */ private $consumerStatus; + /** + * @var \DateTimeImmutable + */ private $consumerCreationTimestamp; /** * The ARN of the stream with which you registered the consumer. + * + * @var string */ private $streamArn; diff --git a/src/Service/Kinesis/src/ValueObject/EnhancedMetrics.php b/src/Service/Kinesis/src/ValueObject/EnhancedMetrics.php index 5db400afc..23dff8d3f 100644 --- a/src/Service/Kinesis/src/ValueObject/EnhancedMetrics.php +++ b/src/Service/Kinesis/src/ValueObject/EnhancedMetrics.php @@ -27,6 +27,8 @@ final class EnhancedMetrics * *Amazon Kinesis Data Streams Developer Guide*. * * [^1]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html + * + * @var list|null */ private $shardLevelMetrics; diff --git a/src/Service/Kinesis/src/ValueObject/HashKeyRange.php b/src/Service/Kinesis/src/ValueObject/HashKeyRange.php index aa9a10da2..e6c3b11a8 100644 --- a/src/Service/Kinesis/src/ValueObject/HashKeyRange.php +++ b/src/Service/Kinesis/src/ValueObject/HashKeyRange.php @@ -11,11 +11,15 @@ final class HashKeyRange { /** * The starting hash key of the hash key range. + * + * @var string */ private $startingHashKey; /** * The ending hash key of the hash key range. + * + * @var string */ private $endingHashKey; diff --git a/src/Service/Kinesis/src/ValueObject/PutRecordsRequestEntry.php b/src/Service/Kinesis/src/ValueObject/PutRecordsRequestEntry.php index 102082265..567cd751a 100644 --- a/src/Service/Kinesis/src/ValueObject/PutRecordsRequestEntry.php +++ b/src/Service/Kinesis/src/ValueObject/PutRecordsRequestEntry.php @@ -13,12 +13,16 @@ final class PutRecordsRequestEntry * The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the * payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record * size (1 MiB). + * + * @var string */ private $data; /** * The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition * key hash. + * + * @var string|null */ private $explicitHashKey; @@ -28,6 +32,8 @@ final class PutRecordsRequestEntry * hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function * is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of * this hashing mechanism, all data records with the same partition key map to the same shard within the stream. + * + * @var string */ private $partitionKey; diff --git a/src/Service/Kinesis/src/ValueObject/PutRecordsResultEntry.php b/src/Service/Kinesis/src/ValueObject/PutRecordsResultEntry.php index 1c31d2a7d..7aca89925 100644 --- a/src/Service/Kinesis/src/ValueObject/PutRecordsResultEntry.php +++ b/src/Service/Kinesis/src/ValueObject/PutRecordsResultEntry.php @@ -11,17 +11,23 @@ final class PutRecordsResultEntry { /** * The sequence number for an individual record result. + * + * @var string|null */ private $sequenceNumber; /** * The shard ID for an individual record result. + * + * @var string|null */ private $shardId; /** * The error code for an individual record result. `ErrorCodes` can be either `ProvisionedThroughputExceededException` * or `InternalFailure`. + * + * @var string|null */ private $errorCode; @@ -29,6 +35,8 @@ final class PutRecordsResultEntry * The error message for an individual record result. An `ErrorCode` value of `ProvisionedThroughputExceededException` * has an error message that includes the account ID, stream name, and shard ID. An `ErrorCode` value of * `InternalFailure` has the error message `"Internal Service Failure"`. + * + * @var string|null */ private $errorMessage; diff --git a/src/Service/Kinesis/src/ValueObject/Record.php b/src/Service/Kinesis/src/ValueObject/Record.php index 6a729cbf4..aa0d90ca8 100644 --- a/src/Service/Kinesis/src/ValueObject/Record.php +++ b/src/Service/Kinesis/src/ValueObject/Record.php @@ -13,11 +13,15 @@ final class Record { /** * The unique identifier of the record within its shard. + * + * @var string */ private $sequenceNumber; /** * The approximate time that the record was inserted into the stream. + * + * @var \DateTimeImmutable|null */ private $approximateArrivalTimestamp; @@ -25,11 +29,15 @@ final class Record * The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, * interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is * added to the partition key size, the total size must not exceed the maximum record size (1 MiB). + * + * @var string */ private $data; /** * Identifies which shard in the stream the data record is assigned to. + * + * @var string */ private $partitionKey; @@ -39,6 +47,8 @@ final class Record * - `NONE`: Do not encrypt the records in the stream. * - `KMS`: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS * key. + * + * @var EncryptionType::*|null */ private $encryptionType; diff --git a/src/Service/Kinesis/src/ValueObject/SequenceNumberRange.php b/src/Service/Kinesis/src/ValueObject/SequenceNumberRange.php index 52a7c69a7..0440d8c34 100644 --- a/src/Service/Kinesis/src/ValueObject/SequenceNumberRange.php +++ b/src/Service/Kinesis/src/ValueObject/SequenceNumberRange.php @@ -11,11 +11,15 @@ final class SequenceNumberRange { /** * The starting sequence number for the range. + * + * @var string */ private $startingSequenceNumber; /** * The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of `null`. + * + * @var string|null */ private $endingSequenceNumber; diff --git a/src/Service/Kinesis/src/ValueObject/Shard.php b/src/Service/Kinesis/src/ValueObject/Shard.php index 22e2a378b..2f26256a9 100644 --- a/src/Service/Kinesis/src/ValueObject/Shard.php +++ b/src/Service/Kinesis/src/ValueObject/Shard.php @@ -11,26 +11,36 @@ final class Shard { /** * The unique identifier of the shard within the stream. + * + * @var string */ private $shardId; /** * The shard ID of the shard's parent. + * + * @var string|null */ private $parentShardId; /** * The shard ID of the shard adjacent to the shard's parent. + * + * @var string|null */ private $adjacentParentShardId; /** * The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers. + * + * @var HashKeyRange */ private $hashKeyRange; /** * The range of possible sequence numbers for the shard. + * + * @var SequenceNumberRange */ private $sequenceNumberRange; diff --git a/src/Service/Kinesis/src/ValueObject/ShardFilter.php b/src/Service/Kinesis/src/ValueObject/ShardFilter.php index 23017d50d..cfc70bcc6 100644 --- a/src/Service/Kinesis/src/ValueObject/ShardFilter.php +++ b/src/Service/Kinesis/src/ValueObject/ShardFilter.php @@ -26,12 +26,16 @@ final class ShardFilter * - `FROM_TIMESTAMP` - the response incldues all closed shards whose end timestamp is greater than or equal to the * given timestamp and also all open shards. Corrected to `TRIM_HORIZON` of the data stream if `FROM_TIMESTAMP` is * less than the `TRIM_HORIZON` value. + * + * @var ShardFilterType::* */ private $type; /** * The exclusive start `shardID` speified in the `ShardFilter` parameter. This property can only be used if the * `AFTER_SHARD_ID` shard type is specified. + * + * @var string|null */ private $shardId; @@ -39,6 +43,8 @@ final class ShardFilter * The timestamps specified in the `ShardFilter` parameter. A timestamp is a Unix epoch date with precision in * milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if * `FROM_TIMESTAMP` or `AT_TIMESTAMP` shard types are specified. + * + * @var \DateTimeImmutable|null */ private $timestamp; diff --git a/src/Service/Kinesis/src/ValueObject/StreamDescription.php b/src/Service/Kinesis/src/ValueObject/StreamDescription.php index 4b5635238..71f8a0578 100644 --- a/src/Service/Kinesis/src/ValueObject/StreamDescription.php +++ b/src/Service/Kinesis/src/ValueObject/StreamDescription.php @@ -13,11 +13,15 @@ final class StreamDescription { /** * The name of the stream being described. + * + * @var string */ private $streamName; /** * The Amazon Resource Name (ARN) for the stream being described. + * + * @var string */ private $streamArn; @@ -32,37 +36,51 @@ final class StreamDescription * write operations only on an `ACTIVE` stream. * - `UPDATING` - Shards in the stream are being merged or split. Read and write operations continue to work while the * stream is in the `UPDATING` state. + * + * @var StreamStatus::* */ private $streamStatus; /** * Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can * choose between an **on-demand** capacity mode and a **provisioned** capacity mode for your data streams. + * + * @var StreamModeDetails|null */ private $streamModeDetails; /** * The shards that comprise the stream. + * + * @var Shard[] */ private $shards; /** * If set to `true`, more shards in the stream are available to describe. + * + * @var bool */ private $hasMoreShards; /** * The current retention period, in hours. Minimum value of 24. Maximum value of 168. + * + * @var int */ private $retentionPeriodHours; /** * The approximate time that the stream was created. + * + * @var \DateTimeImmutable */ private $streamCreationTimestamp; /** * Represents the current enhanced monitoring settings of the stream. + * + * @var EnhancedMetrics[] */ private $enhancedMonitoring; @@ -72,6 +90,8 @@ final class StreamDescription * - `NONE`: Do not encrypt the records in the stream. * - `KMS`: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS * key. + * + * @var EncryptionType::*|null */ private $encryptionType; @@ -85,6 +105,8 @@ final class StreamDescription * - Globally unique key ID example: `12345678-1234-1234-1234-123456789012` * - Alias name example: `alias/MyAliasName` * - Master key owned by Kinesis Data Streams: `alias/aws/kinesis` + * + * @var string|null */ private $keyId; diff --git a/src/Service/Kinesis/src/ValueObject/StreamDescriptionSummary.php b/src/Service/Kinesis/src/ValueObject/StreamDescriptionSummary.php index 6d29315d4..70fe15629 100644 --- a/src/Service/Kinesis/src/ValueObject/StreamDescriptionSummary.php +++ b/src/Service/Kinesis/src/ValueObject/StreamDescriptionSummary.php @@ -13,11 +13,15 @@ final class StreamDescriptionSummary { /** * The name of the stream being described. + * + * @var string */ private $streamName; /** * The Amazon Resource Name (ARN) for the stream being described. + * + * @var string */ private $streamArn; @@ -32,27 +36,37 @@ final class StreamDescriptionSummary * write operations only on an `ACTIVE` stream. * - `UPDATING` - Shards in the stream are being merged or split. Read and write operations continue to work while the * stream is in the `UPDATING` state. + * + * @var StreamStatus::* */ private $streamStatus; /** * Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can * choose between an **on-demand** ycapacity mode and a **provisioned** capacity mode for your data streams. + * + * @var StreamModeDetails|null */ private $streamModeDetails; /** * The current retention period, in hours. + * + * @var int */ private $retentionPeriodHours; /** * The approximate time that the stream was created. + * + * @var \DateTimeImmutable */ private $streamCreationTimestamp; /** * Represents the current enhanced monitoring settings of the stream. + * + * @var EnhancedMetrics[] */ private $enhancedMonitoring; @@ -61,6 +75,8 @@ final class StreamDescriptionSummary * * - `KMS` * - `NONE` + * + * @var EncryptionType::*|null */ private $encryptionType; @@ -74,16 +90,22 @@ final class StreamDescriptionSummary * - Globally unique key ID example: `12345678-1234-1234-1234-123456789012` * - Alias name example: `alias/MyAliasName` * - Master key owned by Kinesis Data Streams: `alias/aws/kinesis` + * + * @var string|null */ private $keyId; /** * The number of open shards in the stream. + * + * @var int */ private $openShardCount; /** * The number of enhanced fan-out consumers registered with the stream. + * + * @var int|null */ private $consumerCount; diff --git a/src/Service/Kinesis/src/ValueObject/StreamModeDetails.php b/src/Service/Kinesis/src/ValueObject/StreamModeDetails.php index c389c0a7d..105940a13 100644 --- a/src/Service/Kinesis/src/ValueObject/StreamModeDetails.php +++ b/src/Service/Kinesis/src/ValueObject/StreamModeDetails.php @@ -14,6 +14,8 @@ final class StreamModeDetails /** * Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can * choose between an **on-demand** capacity mode and a **provisioned** capacity mode for your data streams. + * + * @var StreamMode::* */ private $streamMode; diff --git a/src/Service/Kinesis/src/ValueObject/StreamSummary.php b/src/Service/Kinesis/src/ValueObject/StreamSummary.php index fbc9e3436..fcadf0e16 100644 --- a/src/Service/Kinesis/src/ValueObject/StreamSummary.php +++ b/src/Service/Kinesis/src/ValueObject/StreamSummary.php @@ -12,23 +12,34 @@ final class StreamSummary { /** * The name of a stream. + * + * @var string */ private $streamName; /** * The ARN of the stream. + * + * @var string */ private $streamArn; /** * The status of the stream. + * + * @var StreamStatus::* */ private $streamStatus; + /** + * @var StreamModeDetails|null + */ private $streamModeDetails; /** * The timestamp at which the stream was created. + * + * @var \DateTimeImmutable|null */ private $streamCreationTimestamp; diff --git a/src/Service/Kinesis/src/ValueObject/Tag.php b/src/Service/Kinesis/src/ValueObject/Tag.php index 720854963..8e2fb46d9 100644 --- a/src/Service/Kinesis/src/ValueObject/Tag.php +++ b/src/Service/Kinesis/src/ValueObject/Tag.php @@ -12,12 +12,16 @@ final class Tag /** * A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white * space, _ . / = + - % @. + * + * @var string */ private $key; /** * An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: * Unicode letters, digits, white space, _ . / = + - % @. + * + * @var string|null */ private $value; diff --git a/src/Service/Kms/src/Result/CreateKeyResponse.php b/src/Service/Kms/src/Result/CreateKeyResponse.php index 5712f2f9f..47a82e35b 100644 --- a/src/Service/Kms/src/Result/CreateKeyResponse.php +++ b/src/Service/Kms/src/Result/CreateKeyResponse.php @@ -16,6 +16,8 @@ class CreateKeyResponse extends Result { /** * Metadata associated with the KMS key. + * + * @var KeyMetadata|null */ private $keyMetadata; diff --git a/src/Service/Kms/src/Result/DecryptResponse.php b/src/Service/Kms/src/Result/DecryptResponse.php index 9bc912c3f..5de67e22f 100644 --- a/src/Service/Kms/src/Result/DecryptResponse.php +++ b/src/Service/Kms/src/Result/DecryptResponse.php @@ -12,6 +12,8 @@ class DecryptResponse extends Result * The Amazon Resource Name (key ARN [^1]) of the KMS key that was used to decrypt the ciphertext. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN + * + * @var string|null */ private $keyId; @@ -20,11 +22,15 @@ class DecryptResponse extends Result * Otherwise, it is not Base64-encoded. * * If the response includes the `CiphertextForRecipient` field, the `Plaintext` field is null or empty. + * + * @var string|null */ private $plaintext; /** * The encryption algorithm that was used to decrypt the ciphertext. + * + * @var EncryptionAlgorithmSpec::*|null */ private $encryptionAlgorithm; @@ -37,6 +43,8 @@ class DecryptResponse extends Result * Service Developer Guide*. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html + * + * @var string|null */ private $ciphertextForRecipient; diff --git a/src/Service/Kms/src/Result/EncryptResponse.php b/src/Service/Kms/src/Result/EncryptResponse.php index 129f97cc1..4cbea59e0 100644 --- a/src/Service/Kms/src/Result/EncryptResponse.php +++ b/src/Service/Kms/src/Result/EncryptResponse.php @@ -11,6 +11,8 @@ class EncryptResponse extends Result /** * The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. * Otherwise, it is not Base64-encoded. + * + * @var string|null */ private $ciphertextBlob; @@ -18,11 +20,15 @@ class EncryptResponse extends Result * The Amazon Resource Name (key ARN [^1]) of the KMS key that was used to encrypt the plaintext. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN + * + * @var string|null */ private $keyId; /** * The encryption algorithm that was used to encrypt the plaintext. + * + * @var EncryptionAlgorithmSpec::*|null */ private $encryptionAlgorithm; diff --git a/src/Service/Kms/src/Result/GenerateDataKeyResponse.php b/src/Service/Kms/src/Result/GenerateDataKeyResponse.php index 11d6065a4..e43daab0f 100644 --- a/src/Service/Kms/src/Result/GenerateDataKeyResponse.php +++ b/src/Service/Kms/src/Result/GenerateDataKeyResponse.php @@ -10,6 +10,8 @@ class GenerateDataKeyResponse extends Result /** * The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is * Base64-encoded. Otherwise, it is not Base64-encoded. + * + * @var string|null */ private $ciphertextBlob; @@ -19,6 +21,8 @@ class GenerateDataKeyResponse extends Result * memory as soon as possible. * * If the response includes the `CiphertextForRecipient` field, the `Plaintext` field is null or empty. + * + * @var string|null */ private $plaintext; @@ -26,6 +30,8 @@ class GenerateDataKeyResponse extends Result * The Amazon Resource Name (key ARN [^1]) of the KMS key that encrypted the data key. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN + * + * @var string|null */ private $keyId; @@ -39,6 +45,8 @@ class GenerateDataKeyResponse extends Result * Service Developer Guide*. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html + * + * @var string|null */ private $ciphertextForRecipient; diff --git a/src/Service/Kms/src/Result/ListAliasesResponse.php b/src/Service/Kms/src/Result/ListAliasesResponse.php index 5680971bf..b8f44ef30 100644 --- a/src/Service/Kms/src/Result/ListAliasesResponse.php +++ b/src/Service/Kms/src/Result/ListAliasesResponse.php @@ -16,12 +16,16 @@ class ListAliasesResponse extends Result implements \IteratorAggregate { /** * A list of aliases. + * + * @var AliasListEntry[] */ private $aliases; /** * When `Truncated` is true, this element is present and contains the value to use for the `Marker` parameter in a * subsequent request. + * + * @var string|null */ private $nextMarker; @@ -29,6 +33,8 @@ class ListAliasesResponse extends Result implements \IteratorAggregate * A flag that indicates whether there are more items in the list. When this value is true, the list in this response is * truncated. To get more items, pass the value of the `NextMarker` element in thisresponse to the `Marker` parameter in * a subsequent request. + * + * @var bool|null */ private $truncated; diff --git a/src/Service/Kms/src/Result/SignResponse.php b/src/Service/Kms/src/Result/SignResponse.php index 259241f08..9cc296870 100644 --- a/src/Service/Kms/src/Result/SignResponse.php +++ b/src/Service/Kms/src/Result/SignResponse.php @@ -12,6 +12,8 @@ class SignResponse extends Result * The Amazon Resource Name (key ARN [^1]) of the asymmetric KMS key that was used to sign the message. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN + * + * @var string|null */ private $keyId; @@ -29,11 +31,15 @@ class SignResponse extends Result * * [^1]: https://tools.ietf.org/html/rfc8017 * [^2]: https://tools.ietf.org/html/rfc3279#section-2.2.3 + * + * @var string|null */ private $signature; /** * The signing algorithm that was used to sign the message. + * + * @var SigningAlgorithmSpec::*|null */ private $signingAlgorithm; diff --git a/src/Service/Kms/src/ValueObject/AliasListEntry.php b/src/Service/Kms/src/ValueObject/AliasListEntry.php index 43e5607aa..e69cc217f 100644 --- a/src/Service/Kms/src/ValueObject/AliasListEntry.php +++ b/src/Service/Kms/src/ValueObject/AliasListEntry.php @@ -9,27 +9,37 @@ final class AliasListEntry { /** * String that contains the alias. This value begins with `alias/`. + * + * @var string|null */ private $aliasName; /** * String that contains the key ARN. + * + * @var string|null */ private $aliasArn; /** * String that contains the key identifier of the KMS key associated with the alias. + * + * @var string|null */ private $targetKeyId; /** * Date and time that the alias was most recently created in the account and Region. Formatted as Unix time. + * + * @var \DateTimeImmutable|null */ private $creationDate; /** * Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix * time. + * + * @var \DateTimeImmutable|null */ private $lastUpdatedDate; diff --git a/src/Service/Kms/src/ValueObject/KeyMetadata.php b/src/Service/Kms/src/ValueObject/KeyMetadata.php index b1b05913e..6dfaaadf0 100644 --- a/src/Service/Kms/src/ValueObject/KeyMetadata.php +++ b/src/Service/Kms/src/ValueObject/KeyMetadata.php @@ -23,11 +23,15 @@ final class KeyMetadata { /** * The twelve-digit account ID of the Amazon Web Services account that owns the KMS key. + * + * @var string|null */ private $awsAccountId; /** * The globally unique identifier for the KMS key. + * + * @var string */ private $keyId; @@ -36,21 +40,29 @@ final class KeyMetadata * ARNs section of the *Amazon Web Services General Reference*. * * [^1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms + * + * @var string|null */ private $arn; /** * The date and time when the KMS key was created. + * + * @var \DateTimeImmutable|null */ private $creationDate; /** * Specifies whether the KMS key is enabled. When `KeyState` is `Enabled` this value is true, otherwise it is false. + * + * @var bool|null */ private $enabled; /** * The description of the KMS key. + * + * @var string|null */ private $description; @@ -58,6 +70,8 @@ final class KeyMetadata * The cryptographic operations [^1] for which you can use the KMS key. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations + * + * @var KeyUsageType::*|null */ private $keyUsage; @@ -68,6 +82,8 @@ final class KeyMetadata * Management Service Developer Guide*. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html + * + * @var KeyState::*|null */ private $keyState; @@ -78,6 +94,8 @@ final class KeyMetadata * When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is * `PendingReplicaDeletion` and the length of its waiting period is displayed in the `PendingDeletionWindowInDays` * field. + * + * @var \DateTimeImmutable|null */ private $deletionDate; @@ -85,6 +103,8 @@ final class KeyMetadata * The time at which the imported key material expires. When the key material expires, KMS deletes the key material and * the KMS key becomes unusable. This value is present only for KMS keys whose `Origin` is `EXTERNAL` and whose * `ExpirationModel` is `KEY_MATERIAL_EXPIRES`, otherwise this value is omitted. + * + * @var \DateTimeImmutable|null */ private $validTo; @@ -92,6 +112,8 @@ final class KeyMetadata * The source of the key material for the KMS key. When this value is `AWS_KMS`, KMS created the key material. When this * value is `EXTERNAL`, the key material was imported or the KMS key doesn't have any key material. When this value is * `AWS_CLOUDHSM`, the key material was created in the CloudHSM cluster associated with a custom key store. + * + * @var OriginType::*|null */ private $origin; @@ -100,6 +122,8 @@ final class KeyMetadata * key is created in a custom key store. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html + * + * @var string|null */ private $customKeyStoreId; @@ -109,12 +133,16 @@ final class KeyMetadata * This field is present only when the KMS key is created in an CloudHSM key store. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html + * + * @var string|null */ private $cloudHsmClusterId; /** * Specifies whether the KMS key's key material expires. This value is present only when `Origin` is `EXTERNAL`, * otherwise this value is omitted. + * + * @var ExpirationModelType::*|null */ private $expirationModel; @@ -124,6 +152,8 @@ final class KeyMetadata * Developer Guide*. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys + * + * @var KeyManagerType::*|null */ private $keyManager; @@ -132,11 +162,15 @@ final class KeyMetadata * * The `KeySpec` and `CustomerMasterKeySpec` fields have the same value. We recommend that you use the `KeySpec` field * in your code. However, to avoid breaking changes, KMS supports both fields. + * + * @var CustomerMasterKeySpec::*|null */ private $customerMasterKeySpec; /** * Describes the type of key material in the KMS key. + * + * @var KeySpec::*|null */ private $keySpec; @@ -145,6 +179,8 @@ final class KeyMetadata * within KMS. * * This value is present only when the `KeyUsage` of the KMS key is `ENCRYPT_DECRYPT`. + * + * @var list|null */ private $encryptionAlgorithms; @@ -153,6 +189,8 @@ final class KeyMetadata * KMS. * * This field appears only when the `KeyUsage` of the KMS key is `SIGN_VERIFY`. + * + * @var list|null */ private $signingAlgorithms; @@ -164,6 +202,8 @@ final class KeyMetadata * Developer Guide*. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html + * + * @var bool|null */ private $multiRegion; @@ -178,6 +218,8 @@ final class KeyMetadata * the primary key. * - `ReplicaKeys` displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it * is a replica key. + * + * @var MultiRegionConfiguration|null */ private $multiRegionConfiguration; @@ -192,6 +234,8 @@ final class KeyMetadata * waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When * the last replica key in the multi-Region key is deleted, the `KeyState` of the scheduled primary key changes from * `PendingReplicaDeletion` to `PendingDeletion` and the deletion date appears in the `DeletionDate` field. + * + * @var int|null */ private $pendingDeletionWindowInDays; @@ -199,6 +243,8 @@ final class KeyMetadata * The message authentication code (MAC) algorithm that the HMAC KMS key supports. * * This value is present only when the `KeyUsage` of the KMS key is `GENERATE_VERIFY_MAC`. + * + * @var list|null */ private $macAlgorithms; @@ -208,6 +254,8 @@ final class KeyMetadata * For more information, see External key [^1] in the *Key Management Service Developer Guide*. * * [^1]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key + * + * @var XksKeyConfigurationType|null */ private $xksKeyConfiguration; diff --git a/src/Service/Kms/src/ValueObject/MultiRegionConfiguration.php b/src/Service/Kms/src/ValueObject/MultiRegionConfiguration.php index b1e72938a..3ed0a8caa 100644 --- a/src/Service/Kms/src/ValueObject/MultiRegionConfiguration.php +++ b/src/Service/Kms/src/ValueObject/MultiRegionConfiguration.php @@ -14,17 +14,23 @@ final class MultiRegionConfiguration { /** * Indicates whether the KMS key is a `PRIMARY` or `REPLICA` key. + * + * @var MultiRegionKeyType::*|null */ private $multiRegionKeyType; /** * Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key. + * + * @var MultiRegionKey|null */ private $primaryKey; /** * displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica * key. + * + * @var MultiRegionKey[]|null */ private $replicaKeys; diff --git a/src/Service/Kms/src/ValueObject/MultiRegionKey.php b/src/Service/Kms/src/ValueObject/MultiRegionKey.php index 617cf6875..c012ebfc7 100644 --- a/src/Service/Kms/src/ValueObject/MultiRegionKey.php +++ b/src/Service/Kms/src/ValueObject/MultiRegionKey.php @@ -9,11 +9,15 @@ final class MultiRegionKey { /** * Displays the key ARN of a primary or replica key of a multi-Region key. + * + * @var string|null */ private $arn; /** * Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key. + * + * @var string|null */ private $region; diff --git a/src/Service/Kms/src/ValueObject/RecipientInfo.php b/src/Service/Kms/src/ValueObject/RecipientInfo.php index 8c8078849..3549e9af4 100644 --- a/src/Service/Kms/src/ValueObject/RecipientInfo.php +++ b/src/Service/Kms/src/ValueObject/RecipientInfo.php @@ -19,11 +19,15 @@ final class RecipientInfo /** * The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt * plaintext values for the response. The only valid value is `RSAES_OAEP_SHA_256`. + * + * @var KeyEncryptionMechanism::*|null */ private $keyEncryptionAlgorithm; /** * The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key. + * + * @var string|null */ private $attestationDocument; diff --git a/src/Service/Kms/src/ValueObject/Tag.php b/src/Service/Kms/src/ValueObject/Tag.php index 372b613d0..a2400ea3c 100644 --- a/src/Service/Kms/src/ValueObject/Tag.php +++ b/src/Service/Kms/src/ValueObject/Tag.php @@ -20,11 +20,15 @@ final class Tag { /** * The key of the tag. + * + * @var string */ private $tagKey; /** * The value of the tag. + * + * @var string */ private $tagValue; diff --git a/src/Service/Kms/src/ValueObject/XksKeyConfigurationType.php b/src/Service/Kms/src/ValueObject/XksKeyConfigurationType.php index 1d8534517..1322b1f43 100644 --- a/src/Service/Kms/src/ValueObject/XksKeyConfigurationType.php +++ b/src/Service/Kms/src/ValueObject/XksKeyConfigurationType.php @@ -20,6 +20,8 @@ final class XksKeyConfigurationType /** * The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to * identify the external key. + * + * @var string|null */ private $id; diff --git a/src/Service/Lambda/src/Exception/CodeStorageExceededException.php b/src/Service/Lambda/src/Exception/CodeStorageExceededException.php index 4c05fa217..1d48e4fca 100644 --- a/src/Service/Lambda/src/Exception/CodeStorageExceededException.php +++ b/src/Service/Lambda/src/Exception/CodeStorageExceededException.php @@ -15,6 +15,8 @@ final class CodeStorageExceededException extends ClientException { /** * The exception type. + * + * @var string|null */ private $type; diff --git a/src/Service/Lambda/src/Exception/EC2AccessDeniedException.php b/src/Service/Lambda/src/Exception/EC2AccessDeniedException.php index 41a6fde98..484714f95 100644 --- a/src/Service/Lambda/src/Exception/EC2AccessDeniedException.php +++ b/src/Service/Lambda/src/Exception/EC2AccessDeniedException.php @@ -10,6 +10,9 @@ */ final class EC2AccessDeniedException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/EC2ThrottledException.php b/src/Service/Lambda/src/Exception/EC2ThrottledException.php index e1363bac6..92c62d2e5 100644 --- a/src/Service/Lambda/src/Exception/EC2ThrottledException.php +++ b/src/Service/Lambda/src/Exception/EC2ThrottledException.php @@ -10,6 +10,9 @@ */ final class EC2ThrottledException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/EC2UnexpectedException.php b/src/Service/Lambda/src/Exception/EC2UnexpectedException.php index eb0778eec..1e8d4974b 100644 --- a/src/Service/Lambda/src/Exception/EC2UnexpectedException.php +++ b/src/Service/Lambda/src/Exception/EC2UnexpectedException.php @@ -10,8 +10,14 @@ */ final class EC2UnexpectedException extends ServerException { + /** + * @var string|null + */ private $type; + /** + * @var string|null + */ private $ec2ErrorCode; public function getEc2ErrorCode(): ?string diff --git a/src/Service/Lambda/src/Exception/EFSIOException.php b/src/Service/Lambda/src/Exception/EFSIOException.php index 4dfa2a119..9e0a76a66 100644 --- a/src/Service/Lambda/src/Exception/EFSIOException.php +++ b/src/Service/Lambda/src/Exception/EFSIOException.php @@ -10,6 +10,9 @@ */ final class EFSIOException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/EFSMountConnectivityException.php b/src/Service/Lambda/src/Exception/EFSMountConnectivityException.php index f39978d42..623ce6461 100644 --- a/src/Service/Lambda/src/Exception/EFSMountConnectivityException.php +++ b/src/Service/Lambda/src/Exception/EFSMountConnectivityException.php @@ -10,6 +10,9 @@ */ final class EFSMountConnectivityException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/EFSMountFailureException.php b/src/Service/Lambda/src/Exception/EFSMountFailureException.php index 901f4cba6..ad8eb3237 100644 --- a/src/Service/Lambda/src/Exception/EFSMountFailureException.php +++ b/src/Service/Lambda/src/Exception/EFSMountFailureException.php @@ -10,6 +10,9 @@ */ final class EFSMountFailureException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/EFSMountTimeoutException.php b/src/Service/Lambda/src/Exception/EFSMountTimeoutException.php index b9e38988a..81d1d3b0f 100644 --- a/src/Service/Lambda/src/Exception/EFSMountTimeoutException.php +++ b/src/Service/Lambda/src/Exception/EFSMountTimeoutException.php @@ -10,6 +10,9 @@ */ final class EFSMountTimeoutException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/ENILimitReachedException.php b/src/Service/Lambda/src/Exception/ENILimitReachedException.php index c808b1d1a..bb4159637 100644 --- a/src/Service/Lambda/src/Exception/ENILimitReachedException.php +++ b/src/Service/Lambda/src/Exception/ENILimitReachedException.php @@ -13,6 +13,9 @@ */ final class ENILimitReachedException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/InvalidParameterValueException.php b/src/Service/Lambda/src/Exception/InvalidParameterValueException.php index 4bdda3fc8..eeb2792ab 100644 --- a/src/Service/Lambda/src/Exception/InvalidParameterValueException.php +++ b/src/Service/Lambda/src/Exception/InvalidParameterValueException.php @@ -12,6 +12,8 @@ final class InvalidParameterValueException extends ClientException { /** * The exception type. + * + * @var string|null */ private $type; diff --git a/src/Service/Lambda/src/Exception/InvalidRequestContentException.php b/src/Service/Lambda/src/Exception/InvalidRequestContentException.php index e76c50de3..80524c35d 100644 --- a/src/Service/Lambda/src/Exception/InvalidRequestContentException.php +++ b/src/Service/Lambda/src/Exception/InvalidRequestContentException.php @@ -12,6 +12,8 @@ final class InvalidRequestContentException extends ClientException { /** * The exception type. + * + * @var string|null */ private $type; diff --git a/src/Service/Lambda/src/Exception/InvalidRuntimeException.php b/src/Service/Lambda/src/Exception/InvalidRuntimeException.php index f47904d4f..fa87b4407 100644 --- a/src/Service/Lambda/src/Exception/InvalidRuntimeException.php +++ b/src/Service/Lambda/src/Exception/InvalidRuntimeException.php @@ -10,6 +10,9 @@ */ final class InvalidRuntimeException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/InvalidSecurityGroupIDException.php b/src/Service/Lambda/src/Exception/InvalidSecurityGroupIDException.php index 2f6038e16..448e0bdab 100644 --- a/src/Service/Lambda/src/Exception/InvalidSecurityGroupIDException.php +++ b/src/Service/Lambda/src/Exception/InvalidSecurityGroupIDException.php @@ -10,6 +10,9 @@ */ final class InvalidSecurityGroupIDException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/InvalidSubnetIDException.php b/src/Service/Lambda/src/Exception/InvalidSubnetIDException.php index db660785c..90cce3f5b 100644 --- a/src/Service/Lambda/src/Exception/InvalidSubnetIDException.php +++ b/src/Service/Lambda/src/Exception/InvalidSubnetIDException.php @@ -10,6 +10,9 @@ */ final class InvalidSubnetIDException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/InvalidZipFileException.php b/src/Service/Lambda/src/Exception/InvalidZipFileException.php index 103ac6a77..28d166466 100644 --- a/src/Service/Lambda/src/Exception/InvalidZipFileException.php +++ b/src/Service/Lambda/src/Exception/InvalidZipFileException.php @@ -10,6 +10,9 @@ */ final class InvalidZipFileException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/KMSAccessDeniedException.php b/src/Service/Lambda/src/Exception/KMSAccessDeniedException.php index 04c659868..48480469f 100644 --- a/src/Service/Lambda/src/Exception/KMSAccessDeniedException.php +++ b/src/Service/Lambda/src/Exception/KMSAccessDeniedException.php @@ -11,6 +11,9 @@ */ final class KMSAccessDeniedException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/KMSDisabledException.php b/src/Service/Lambda/src/Exception/KMSDisabledException.php index eb2275bf7..2228b81d0 100644 --- a/src/Service/Lambda/src/Exception/KMSDisabledException.php +++ b/src/Service/Lambda/src/Exception/KMSDisabledException.php @@ -11,6 +11,9 @@ */ final class KMSDisabledException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/KMSInvalidStateException.php b/src/Service/Lambda/src/Exception/KMSInvalidStateException.php index cabf56a72..f8d7e5341 100644 --- a/src/Service/Lambda/src/Exception/KMSInvalidStateException.php +++ b/src/Service/Lambda/src/Exception/KMSInvalidStateException.php @@ -11,6 +11,9 @@ */ final class KMSInvalidStateException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/KMSNotFoundException.php b/src/Service/Lambda/src/Exception/KMSNotFoundException.php index ed7022662..4c95b3ff5 100644 --- a/src/Service/Lambda/src/Exception/KMSNotFoundException.php +++ b/src/Service/Lambda/src/Exception/KMSNotFoundException.php @@ -11,6 +11,9 @@ */ final class KMSNotFoundException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/PolicyLengthExceededException.php b/src/Service/Lambda/src/Exception/PolicyLengthExceededException.php index e95263fcf..bc40f2edf 100644 --- a/src/Service/Lambda/src/Exception/PolicyLengthExceededException.php +++ b/src/Service/Lambda/src/Exception/PolicyLengthExceededException.php @@ -12,6 +12,9 @@ */ final class PolicyLengthExceededException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/PreconditionFailedException.php b/src/Service/Lambda/src/Exception/PreconditionFailedException.php index 1577e7877..5a057d25e 100644 --- a/src/Service/Lambda/src/Exception/PreconditionFailedException.php +++ b/src/Service/Lambda/src/Exception/PreconditionFailedException.php @@ -13,6 +13,8 @@ final class PreconditionFailedException extends ClientException { /** * The exception type. + * + * @var string|null */ private $type; diff --git a/src/Service/Lambda/src/Exception/RecursiveInvocationException.php b/src/Service/Lambda/src/Exception/RecursiveInvocationException.php index 34fcd3d6e..e8870d517 100644 --- a/src/Service/Lambda/src/Exception/RecursiveInvocationException.php +++ b/src/Service/Lambda/src/Exception/RecursiveInvocationException.php @@ -13,6 +13,8 @@ final class RecursiveInvocationException extends ClientException { /** * The exception type. + * + * @var string|null */ private $type; diff --git a/src/Service/Lambda/src/Exception/RequestTooLargeException.php b/src/Service/Lambda/src/Exception/RequestTooLargeException.php index 12f49ebfc..d05a59136 100644 --- a/src/Service/Lambda/src/Exception/RequestTooLargeException.php +++ b/src/Service/Lambda/src/Exception/RequestTooLargeException.php @@ -13,6 +13,9 @@ */ final class RequestTooLargeException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/ResourceConflictException.php b/src/Service/Lambda/src/Exception/ResourceConflictException.php index 44b8ed82e..51b302126 100644 --- a/src/Service/Lambda/src/Exception/ResourceConflictException.php +++ b/src/Service/Lambda/src/Exception/ResourceConflictException.php @@ -12,6 +12,8 @@ final class ResourceConflictException extends ClientException { /** * The exception type. + * + * @var string|null */ private $type; diff --git a/src/Service/Lambda/src/Exception/ResourceNotFoundException.php b/src/Service/Lambda/src/Exception/ResourceNotFoundException.php index 2d9f376f3..c5e9e6cad 100644 --- a/src/Service/Lambda/src/Exception/ResourceNotFoundException.php +++ b/src/Service/Lambda/src/Exception/ResourceNotFoundException.php @@ -10,6 +10,9 @@ */ final class ResourceNotFoundException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/ResourceNotReadyException.php b/src/Service/Lambda/src/Exception/ResourceNotReadyException.php index 13f9aa60c..7695f1471 100644 --- a/src/Service/Lambda/src/Exception/ResourceNotReadyException.php +++ b/src/Service/Lambda/src/Exception/ResourceNotReadyException.php @@ -13,6 +13,8 @@ final class ResourceNotReadyException extends ServerException { /** * The exception type. + * + * @var string|null */ private $type; diff --git a/src/Service/Lambda/src/Exception/ServiceException.php b/src/Service/Lambda/src/Exception/ServiceException.php index 5af0405c5..76978f54e 100644 --- a/src/Service/Lambda/src/Exception/ServiceException.php +++ b/src/Service/Lambda/src/Exception/ServiceException.php @@ -10,6 +10,9 @@ */ final class ServiceException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/SnapStartException.php b/src/Service/Lambda/src/Exception/SnapStartException.php index 857bdeccb..4a08e71d1 100644 --- a/src/Service/Lambda/src/Exception/SnapStartException.php +++ b/src/Service/Lambda/src/Exception/SnapStartException.php @@ -12,6 +12,9 @@ */ final class SnapStartException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/SnapStartNotReadyException.php b/src/Service/Lambda/src/Exception/SnapStartNotReadyException.php index 7533b6d14..223ad3d81 100644 --- a/src/Service/Lambda/src/Exception/SnapStartNotReadyException.php +++ b/src/Service/Lambda/src/Exception/SnapStartNotReadyException.php @@ -12,6 +12,9 @@ */ final class SnapStartNotReadyException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/SnapStartTimeoutException.php b/src/Service/Lambda/src/Exception/SnapStartTimeoutException.php index c17a77d83..f55429b80 100644 --- a/src/Service/Lambda/src/Exception/SnapStartTimeoutException.php +++ b/src/Service/Lambda/src/Exception/SnapStartTimeoutException.php @@ -10,6 +10,9 @@ */ final class SnapStartTimeoutException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/SubnetIPAddressLimitReachedException.php b/src/Service/Lambda/src/Exception/SubnetIPAddressLimitReachedException.php index 1366f3a40..6ea5364db 100644 --- a/src/Service/Lambda/src/Exception/SubnetIPAddressLimitReachedException.php +++ b/src/Service/Lambda/src/Exception/SubnetIPAddressLimitReachedException.php @@ -11,6 +11,9 @@ */ final class SubnetIPAddressLimitReachedException extends ServerException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Exception/TooManyRequestsException.php b/src/Service/Lambda/src/Exception/TooManyRequestsException.php index 0df7a20bf..df926ed04 100644 --- a/src/Service/Lambda/src/Exception/TooManyRequestsException.php +++ b/src/Service/Lambda/src/Exception/TooManyRequestsException.php @@ -15,11 +15,19 @@ final class TooManyRequestsException extends ClientException { /** * The number of seconds the caller should wait before retrying. + * + * @var string|null */ private $retryAfterSeconds; + /** + * @var string|null + */ private $type; + /** + * @var ThrottleReason::*|null + */ private $reason; /** diff --git a/src/Service/Lambda/src/Exception/UnsupportedMediaTypeException.php b/src/Service/Lambda/src/Exception/UnsupportedMediaTypeException.php index f7e01f46f..46656d425 100644 --- a/src/Service/Lambda/src/Exception/UnsupportedMediaTypeException.php +++ b/src/Service/Lambda/src/Exception/UnsupportedMediaTypeException.php @@ -10,6 +10,9 @@ */ final class UnsupportedMediaTypeException extends ClientException { + /** + * @var string|null + */ private $type; public function getType(): ?string diff --git a/src/Service/Lambda/src/Result/AddLayerVersionPermissionResponse.php b/src/Service/Lambda/src/Result/AddLayerVersionPermissionResponse.php index 08240d390..bca1f9e8a 100644 --- a/src/Service/Lambda/src/Result/AddLayerVersionPermissionResponse.php +++ b/src/Service/Lambda/src/Result/AddLayerVersionPermissionResponse.php @@ -9,11 +9,15 @@ class AddLayerVersionPermissionResponse extends Result { /** * The permission statement. + * + * @var string|null */ private $statement; /** * A unique identifier for the current revision of the policy. + * + * @var string|null */ private $revisionId; diff --git a/src/Service/Lambda/src/Result/InvocationResponse.php b/src/Service/Lambda/src/Result/InvocationResponse.php index 3dda0f41f..07719dd20 100644 --- a/src/Service/Lambda/src/Result/InvocationResponse.php +++ b/src/Service/Lambda/src/Result/InvocationResponse.php @@ -11,28 +11,38 @@ class InvocationResponse extends Result * The HTTP status code is in the 200 range for a successful request. For the `RequestResponse` invocation type, this * status code is 200. For the `Event` invocation type, this status code is 202. For the `DryRun` invocation type, the * status code is 204. + * + * @var int|null */ private $statusCode; /** * If present, indicates that an error occurred during function execution. Details about the error are included in the * response payload. + * + * @var string|null */ private $functionError; /** * The last 4 KB of the execution log, which is base64-encoded. + * + * @var string|null */ private $logResult; /** * The response from the function, or an error object. + * + * @var string|null */ private $payload; /** * The version of the function that executed. When you invoke a function with an alias, this indicates which version the * alias resolved to. + * + * @var string|null */ private $executedVersion; diff --git a/src/Service/Lambda/src/Result/ListFunctionsResponse.php b/src/Service/Lambda/src/Result/ListFunctionsResponse.php index 1b9291708..c13870ca4 100644 --- a/src/Service/Lambda/src/Result/ListFunctionsResponse.php +++ b/src/Service/Lambda/src/Result/ListFunctionsResponse.php @@ -33,11 +33,15 @@ class ListFunctionsResponse extends Result implements \IteratorAggregate { /** * The pagination token that's included if more results are available. + * + * @var string|null */ private $nextMarker; /** * A list of Lambda functions. + * + * @var FunctionConfiguration[] */ private $functions; diff --git a/src/Service/Lambda/src/Result/ListLayerVersionsResponse.php b/src/Service/Lambda/src/Result/ListLayerVersionsResponse.php index eb408a0c9..776b927c8 100644 --- a/src/Service/Lambda/src/Result/ListLayerVersionsResponse.php +++ b/src/Service/Lambda/src/Result/ListLayerVersionsResponse.php @@ -18,11 +18,15 @@ class ListLayerVersionsResponse extends Result implements \IteratorAggregate { /** * A pagination token returned when the response doesn't contain all versions. + * + * @var string|null */ private $nextMarker; /** * A list of versions. + * + * @var LayerVersionsListItem[] */ private $layerVersions; diff --git a/src/Service/Lambda/src/Result/ListVersionsByFunctionResponse.php b/src/Service/Lambda/src/Result/ListVersionsByFunctionResponse.php index 9b02ea58e..6ddc535ab 100644 --- a/src/Service/Lambda/src/Result/ListVersionsByFunctionResponse.php +++ b/src/Service/Lambda/src/Result/ListVersionsByFunctionResponse.php @@ -31,11 +31,15 @@ class ListVersionsByFunctionResponse extends Result implements \IteratorAggregat { /** * The pagination token that's included if more results are available. + * + * @var string|null */ private $nextMarker; /** * A list of Lambda function versions. + * + * @var FunctionConfiguration[] */ private $versions; diff --git a/src/Service/Lambda/src/Result/PublishLayerVersionResponse.php b/src/Service/Lambda/src/Result/PublishLayerVersionResponse.php index ba3a32407..9f3f0ad6d 100644 --- a/src/Service/Lambda/src/Result/PublishLayerVersionResponse.php +++ b/src/Service/Lambda/src/Result/PublishLayerVersionResponse.php @@ -12,21 +12,29 @@ class PublishLayerVersionResponse extends Result { /** * Details about the layer version. + * + * @var LayerVersionContentOutput|null */ private $content; /** * The ARN of the layer. + * + * @var string|null */ private $layerArn; /** * The ARN of the layer version. + * + * @var string|null */ private $layerVersionArn; /** * The description of the version. + * + * @var string|null */ private $description; @@ -34,11 +42,15 @@ class PublishLayerVersionResponse extends Result * The date that the layer version was created, in ISO-8601 format [^1] (YYYY-MM-DDThh:mm:ss.sTZD). * * [^1]: https://www.w3.org/TR/NOTE-datetime + * + * @var string|null */ private $createdDate; /** * The version number. + * + * @var int|null */ private $version; @@ -48,11 +60,15 @@ class PublishLayerVersionResponse extends Result * The following list includes deprecated runtimes. For more information, see Runtime deprecation policy [^1]. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy + * + * @var list */ private $compatibleRuntimes; /** * The layer's software license. + * + * @var string|null */ private $licenseInfo; @@ -60,6 +76,8 @@ class PublishLayerVersionResponse extends Result * A list of compatible instruction set architectures [^1]. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html + * + * @var list */ private $compatibleArchitectures; diff --git a/src/Service/Lambda/src/ValueObject/DeadLetterConfig.php b/src/Service/Lambda/src/ValueObject/DeadLetterConfig.php index eaf348d49..c2de5bfd9 100644 --- a/src/Service/Lambda/src/ValueObject/DeadLetterConfig.php +++ b/src/Service/Lambda/src/ValueObject/DeadLetterConfig.php @@ -11,6 +11,8 @@ final class DeadLetterConfig { /** * The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. + * + * @var string|null */ private $targetArn; diff --git a/src/Service/Lambda/src/ValueObject/EnvironmentError.php b/src/Service/Lambda/src/ValueObject/EnvironmentError.php index a460003f5..071501992 100644 --- a/src/Service/Lambda/src/ValueObject/EnvironmentError.php +++ b/src/Service/Lambda/src/ValueObject/EnvironmentError.php @@ -9,11 +9,15 @@ final class EnvironmentError { /** * The error code. + * + * @var string|null */ private $errorCode; /** * The error message. + * + * @var string|null */ private $message; diff --git a/src/Service/Lambda/src/ValueObject/EnvironmentResponse.php b/src/Service/Lambda/src/ValueObject/EnvironmentResponse.php index 1faa94403..31b991e4e 100644 --- a/src/Service/Lambda/src/ValueObject/EnvironmentResponse.php +++ b/src/Service/Lambda/src/ValueObject/EnvironmentResponse.php @@ -10,11 +10,15 @@ final class EnvironmentResponse { /** * Environment variable key-value pairs. Omitted from CloudTrail logs. + * + * @var array|null */ private $variables; /** * Error messages for environment variables that couldn't be applied. + * + * @var EnvironmentError|null */ private $error; diff --git a/src/Service/Lambda/src/ValueObject/EphemeralStorage.php b/src/Service/Lambda/src/ValueObject/EphemeralStorage.php index 9fe9673d8..63215da79 100644 --- a/src/Service/Lambda/src/ValueObject/EphemeralStorage.php +++ b/src/Service/Lambda/src/ValueObject/EphemeralStorage.php @@ -12,6 +12,8 @@ final class EphemeralStorage { /** * The size of the function's `/tmp` directory. + * + * @var int */ private $size; diff --git a/src/Service/Lambda/src/ValueObject/FileSystemConfig.php b/src/Service/Lambda/src/ValueObject/FileSystemConfig.php index f5e6d48cd..6f1f7883a 100644 --- a/src/Service/Lambda/src/ValueObject/FileSystemConfig.php +++ b/src/Service/Lambda/src/ValueObject/FileSystemConfig.php @@ -13,11 +13,15 @@ final class FileSystemConfig { /** * The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system. + * + * @var string */ private $arn; /** * The path where the function can access the file system, starting with `/mnt/`. + * + * @var string */ private $localMountPath; diff --git a/src/Service/Lambda/src/ValueObject/FunctionConfiguration.php b/src/Service/Lambda/src/ValueObject/FunctionConfiguration.php index 835b36fc9..1375e9881 100644 --- a/src/Service/Lambda/src/ValueObject/FunctionConfiguration.php +++ b/src/Service/Lambda/src/ValueObject/FunctionConfiguration.php @@ -17,11 +17,15 @@ final class FunctionConfiguration { /** * The name of the function. + * + * @var string|null */ private $functionName; /** * The function's Amazon Resource Name (ARN). + * + * @var string|null */ private $functionArn; @@ -32,36 +36,50 @@ final class FunctionConfiguration * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html * [^2]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy + * + * @var Runtime::*|null */ private $runtime; /** * The function's execution role. + * + * @var string|null */ private $role; /** * The function that Lambda calls to begin running your function. + * + * @var string|null */ private $handler; /** * The size of the function's deployment package, in bytes. + * + * @var int|null */ private $codeSize; /** * The function's description. + * + * @var string|null */ private $description; /** * The amount of time in seconds that Lambda allows a function to run before stopping it. + * + * @var int|null */ private $timeout; /** * The amount of memory available to the function at runtime. + * + * @var int|null */ private $memorySize; @@ -69,26 +87,36 @@ final class FunctionConfiguration * The date and time that the function was last updated, in ISO-8601 format [^1] (YYYY-MM-DDThh:mm:ss.sTZD). * * [^1]: https://www.w3.org/TR/NOTE-datetime + * + * @var string|null */ private $lastModified; /** * The SHA256 hash of the function's deployment package. + * + * @var string|null */ private $codeSha256; /** * The version of the Lambda function. + * + * @var string|null */ private $version; /** * The function's networking configuration. + * + * @var VpcConfigResponse|null */ private $vpcConfig; /** * The function's dead letter queue. + * + * @var DeadLetterConfig|null */ private $deadLetterConfig; @@ -96,6 +124,8 @@ final class FunctionConfiguration * The function's environment variables [^1]. Omitted from CloudTrail logs. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html + * + * @var EnvironmentResponse|null */ private $environment; @@ -106,21 +136,29 @@ final class FunctionConfiguration * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption * [^2]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + * + * @var string|null */ private $kmsKeyArn; /** * The function's X-Ray tracing configuration. + * + * @var TracingConfigResponse|null */ private $tracingConfig; /** * For Lambda@Edge functions, the ARN of the main function. + * + * @var string|null */ private $masterArn; /** * The latest updated revision of the function or alias. + * + * @var string|null */ private $revisionId; @@ -128,38 +166,52 @@ final class FunctionConfiguration * The function's layers [^1]. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html + * + * @var Layer[]|null */ private $layers; /** * The current state of the function. When the state is `Inactive`, you can reactivate the function by invoking it. + * + * @var State::*|null */ private $state; /** * The reason for the function's current state. + * + * @var string|null */ private $stateReason; /** * The reason code for the function's current state. When the code is `Creating`, you can't invoke or modify the * function. + * + * @var StateReasonCode::*|null */ private $stateReasonCode; /** * The status of the last update that was performed on the function. This is first set to `Successful` after function * creation completes. + * + * @var LastUpdateStatus::*|null */ private $lastUpdateStatus; /** * The reason for the last update that was performed on the function. + * + * @var string|null */ private $lastUpdateStatusReason; /** * The reason code for the last update that was performed on the function. + * + * @var LastUpdateStatusReasonCode::*|null */ private $lastUpdateStatusReasonCode; @@ -167,38 +219,52 @@ final class FunctionConfiguration * Connection settings for an Amazon EFS file system [^1]. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html + * + * @var FileSystemConfig[]|null */ private $fileSystemConfigs; /** * The type of deployment package. Set to `Image` for container image and set `Zip` for .zip file archive. + * + * @var PackageType::*|null */ private $packageType; /** * The function's image configuration values. + * + * @var ImageConfigResponse|null */ private $imageConfigResponse; /** * The ARN of the signing profile version. + * + * @var string|null */ private $signingProfileVersionArn; /** * The ARN of the signing job. + * + * @var string|null */ private $signingJobArn; /** * The instruction set architecture that the function supports. Architecture is a string array with one of the valid * values. The default architecture value is `x86_64`. + * + * @var list|null */ private $architectures; /** * The size of the function’s `/tmp` directory in MB. The default value is 512, but it can be any whole number between * 512 and 10,240 MB. + * + * @var EphemeralStorage|null */ private $ephemeralStorage; @@ -207,11 +273,15 @@ final class FunctionConfiguration * function version. For more information, see Improving startup performance with Lambda SnapStart [^1]. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html + * + * @var SnapStartResponse|null */ private $snapStart; /** * The ARN of the runtime and any errors that occured. + * + * @var RuntimeVersionConfig|null */ private $runtimeVersionConfig; diff --git a/src/Service/Lambda/src/ValueObject/ImageConfig.php b/src/Service/Lambda/src/ValueObject/ImageConfig.php index a493d31eb..410fa63ff 100644 --- a/src/Service/Lambda/src/ValueObject/ImageConfig.php +++ b/src/Service/Lambda/src/ValueObject/ImageConfig.php @@ -12,16 +12,22 @@ final class ImageConfig { /** * Specifies the entry point to their application, which is typically the location of the runtime executable. + * + * @var string[]|null */ private $entryPoint; /** * Specifies parameters that you want to pass in with ENTRYPOINT. + * + * @var string[]|null */ private $command; /** * Specifies the working directory. + * + * @var string|null */ private $workingDirectory; diff --git a/src/Service/Lambda/src/ValueObject/ImageConfigError.php b/src/Service/Lambda/src/ValueObject/ImageConfigError.php index 212cf3e1b..1447d3850 100644 --- a/src/Service/Lambda/src/ValueObject/ImageConfigError.php +++ b/src/Service/Lambda/src/ValueObject/ImageConfigError.php @@ -9,11 +9,15 @@ final class ImageConfigError { /** * Error code. + * + * @var string|null */ private $errorCode; /** * Error message. + * + * @var string|null */ private $message; diff --git a/src/Service/Lambda/src/ValueObject/ImageConfigResponse.php b/src/Service/Lambda/src/ValueObject/ImageConfigResponse.php index 1bd7f93bb..00fc32517 100644 --- a/src/Service/Lambda/src/ValueObject/ImageConfigResponse.php +++ b/src/Service/Lambda/src/ValueObject/ImageConfigResponse.php @@ -9,11 +9,15 @@ final class ImageConfigResponse { /** * Configuration values that override the container image Dockerfile. + * + * @var ImageConfig|null */ private $imageConfig; /** * Error response to `GetFunctionConfiguration`. + * + * @var ImageConfigError|null */ private $error; diff --git a/src/Service/Lambda/src/ValueObject/Layer.php b/src/Service/Lambda/src/ValueObject/Layer.php index 01c056118..4db23829c 100644 --- a/src/Service/Lambda/src/ValueObject/Layer.php +++ b/src/Service/Lambda/src/ValueObject/Layer.php @@ -11,21 +11,29 @@ final class Layer { /** * The Amazon Resource Name (ARN) of the function layer. + * + * @var string|null */ private $arn; /** * The size of the layer archive in bytes. + * + * @var int|null */ private $codeSize; /** * The Amazon Resource Name (ARN) for a signing profile version. + * + * @var string|null */ private $signingProfileVersionArn; /** * The Amazon Resource Name (ARN) of a signing job. + * + * @var string|null */ private $signingJobArn; diff --git a/src/Service/Lambda/src/ValueObject/LayerVersionContentInput.php b/src/Service/Lambda/src/ValueObject/LayerVersionContentInput.php index 1be3f8930..7ab58157d 100644 --- a/src/Service/Lambda/src/ValueObject/LayerVersionContentInput.php +++ b/src/Service/Lambda/src/ValueObject/LayerVersionContentInput.php @@ -12,22 +12,30 @@ final class LayerVersionContentInput { /** * The Amazon S3 bucket of the layer archive. + * + * @var string|null */ private $s3Bucket; /** * The Amazon S3 key of the layer archive. + * + * @var string|null */ private $s3Key; /** * For versioned objects, the version of the layer archive object to use. + * + * @var string|null */ private $s3ObjectVersion; /** * The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle * the encoding for you. + * + * @var string|null */ private $zipFile; diff --git a/src/Service/Lambda/src/ValueObject/LayerVersionContentOutput.php b/src/Service/Lambda/src/ValueObject/LayerVersionContentOutput.php index aca73fa68..9ae52bc33 100644 --- a/src/Service/Lambda/src/ValueObject/LayerVersionContentOutput.php +++ b/src/Service/Lambda/src/ValueObject/LayerVersionContentOutput.php @@ -11,26 +11,36 @@ final class LayerVersionContentOutput { /** * A link to the layer archive in Amazon S3 that is valid for 10 minutes. + * + * @var string|null */ private $location; /** * The SHA-256 hash of the layer archive. + * + * @var string|null */ private $codeSha256; /** * The size of the layer archive in bytes. + * + * @var int|null */ private $codeSize; /** * The Amazon Resource Name (ARN) for a signing profile version. + * + * @var string|null */ private $signingProfileVersionArn; /** * The Amazon Resource Name (ARN) of a signing job. + * + * @var string|null */ private $signingJobArn; diff --git a/src/Service/Lambda/src/ValueObject/LayerVersionsListItem.php b/src/Service/Lambda/src/ValueObject/LayerVersionsListItem.php index 3c27b2a98..63cea97d7 100644 --- a/src/Service/Lambda/src/ValueObject/LayerVersionsListItem.php +++ b/src/Service/Lambda/src/ValueObject/LayerVersionsListItem.php @@ -14,21 +14,29 @@ final class LayerVersionsListItem { /** * The ARN of the layer version. + * + * @var string|null */ private $layerVersionArn; /** * The version number. + * + * @var int|null */ private $version; /** * The description of the version. + * + * @var string|null */ private $description; /** * The date that the version was created, in ISO 8601 format. For example, `2018-11-27T15:10:45.123+0000`. + * + * @var string|null */ private $createdDate; @@ -38,11 +46,15 @@ final class LayerVersionsListItem * The following list includes deprecated runtimes. For more information, see Runtime deprecation policy [^1]. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy + * + * @var list|null */ private $compatibleRuntimes; /** * The layer's open-source license. + * + * @var string|null */ private $licenseInfo; @@ -50,6 +62,8 @@ final class LayerVersionsListItem * A list of compatible instruction set architectures [^1]. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html + * + * @var list|null */ private $compatibleArchitectures; diff --git a/src/Service/Lambda/src/ValueObject/RuntimeVersionConfig.php b/src/Service/Lambda/src/ValueObject/RuntimeVersionConfig.php index e07c63ebb..2d62a9fb2 100644 --- a/src/Service/Lambda/src/ValueObject/RuntimeVersionConfig.php +++ b/src/Service/Lambda/src/ValueObject/RuntimeVersionConfig.php @@ -9,11 +9,15 @@ final class RuntimeVersionConfig { /** * The ARN of the runtime version you want the function to use. + * + * @var string|null */ private $runtimeVersionArn; /** * Error response when Lambda is unable to retrieve the runtime version for a function. + * + * @var RuntimeVersionError|null */ private $error; diff --git a/src/Service/Lambda/src/ValueObject/RuntimeVersionError.php b/src/Service/Lambda/src/ValueObject/RuntimeVersionError.php index 25c4dc238..1ca378184 100644 --- a/src/Service/Lambda/src/ValueObject/RuntimeVersionError.php +++ b/src/Service/Lambda/src/ValueObject/RuntimeVersionError.php @@ -9,11 +9,15 @@ final class RuntimeVersionError { /** * The error code. + * + * @var string|null */ private $errorCode; /** * The error message. + * + * @var string|null */ private $message; diff --git a/src/Service/Lambda/src/ValueObject/SnapStartResponse.php b/src/Service/Lambda/src/ValueObject/SnapStartResponse.php index 1d7227505..aa938fcc7 100644 --- a/src/Service/Lambda/src/ValueObject/SnapStartResponse.php +++ b/src/Service/Lambda/src/ValueObject/SnapStartResponse.php @@ -15,6 +15,8 @@ final class SnapStartResponse /** * When set to `PublishedVersions`, Lambda creates a snapshot of the execution environment when you publish a function * version. + * + * @var SnapStartApplyOn::*|null */ private $applyOn; @@ -23,6 +25,8 @@ final class SnapStartResponse * activated for the specified function version. * * [^1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using + * + * @var SnapStartOptimizationStatus::*|null */ private $optimizationStatus; diff --git a/src/Service/Lambda/src/ValueObject/TracingConfigResponse.php b/src/Service/Lambda/src/ValueObject/TracingConfigResponse.php index ea97815fa..51387e7f3 100644 --- a/src/Service/Lambda/src/ValueObject/TracingConfigResponse.php +++ b/src/Service/Lambda/src/ValueObject/TracingConfigResponse.php @@ -11,6 +11,8 @@ final class TracingConfigResponse { /** * The tracing mode. + * + * @var TracingMode::*|null */ private $mode; diff --git a/src/Service/Lambda/src/ValueObject/VpcConfigResponse.php b/src/Service/Lambda/src/ValueObject/VpcConfigResponse.php index 497c07e8f..71df86693 100644 --- a/src/Service/Lambda/src/ValueObject/VpcConfigResponse.php +++ b/src/Service/Lambda/src/ValueObject/VpcConfigResponse.php @@ -9,16 +9,22 @@ final class VpcConfigResponse { /** * A list of VPC subnet IDs. + * + * @var string[]|null */ private $subnetIds; /** * A list of VPC security group IDs. + * + * @var string[]|null */ private $securityGroupIds; /** * The ID of the VPC. + * + * @var string|null */ private $vpcId; diff --git a/src/Service/MediaConvert/src/Result/CreateJobResponse.php b/src/Service/MediaConvert/src/Result/CreateJobResponse.php index 5391aa5eb..e6a1f8d6d 100644 --- a/src/Service/MediaConvert/src/Result/CreateJobResponse.php +++ b/src/Service/MediaConvert/src/Result/CreateJobResponse.php @@ -168,6 +168,8 @@ class CreateJobResponse extends Result /** * Each job converts an input file into an output file or files. For more information, see the User Guide at * https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html. + * + * @var Job|null */ private $job; diff --git a/src/Service/MediaConvert/src/Result/DescribeEndpointsResponse.php b/src/Service/MediaConvert/src/Result/DescribeEndpointsResponse.php index e85cdaf5d..a8c0a9266 100644 --- a/src/Service/MediaConvert/src/Result/DescribeEndpointsResponse.php +++ b/src/Service/MediaConvert/src/Result/DescribeEndpointsResponse.php @@ -18,11 +18,15 @@ class DescribeEndpointsResponse extends Result implements \IteratorAggregate { /** * List of endpoints. + * + * @var Endpoint[] */ private $endpoints; /** * Use this string to request the next batch of endpoints. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/MediaConvert/src/Result/GetJobResponse.php b/src/Service/MediaConvert/src/Result/GetJobResponse.php index 0327f01bc..fba4fd211 100644 --- a/src/Service/MediaConvert/src/Result/GetJobResponse.php +++ b/src/Service/MediaConvert/src/Result/GetJobResponse.php @@ -168,6 +168,8 @@ class GetJobResponse extends Result /** * Each job converts an input file into an output file or files. For more information, see the User Guide at * https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html. + * + * @var Job|null */ private $job; diff --git a/src/Service/MediaConvert/src/Result/ListJobsResponse.php b/src/Service/MediaConvert/src/Result/ListJobsResponse.php index 6700582b5..8ab32332c 100644 --- a/src/Service/MediaConvert/src/Result/ListJobsResponse.php +++ b/src/Service/MediaConvert/src/Result/ListJobsResponse.php @@ -173,11 +173,15 @@ class ListJobsResponse extends Result implements \IteratorAggregate { /** * List of jobs. + * + * @var Job[] */ private $jobs; /** * Use this string to request the next batch of jobs. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/MediaConvert/src/ValueObject/AacSettings.php b/src/Service/MediaConvert/src/ValueObject/AacSettings.php index 1f6458a42..0a6d422b3 100644 --- a/src/Service/MediaConvert/src/ValueObject/AacSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AacSettings.php @@ -27,6 +27,8 @@ final class AacSettings * mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and * FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this * case, the encoder will use any values you provide for AudioType and FollowInputAudioType. + * + * @var AacAudioDescriptionBroadcasterMix::*|null */ private $audioDescriptionBroadcasterMix; @@ -36,11 +38,15 @@ final class AacSettings * 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value * you set is also constrained by the values that you choose for Profile (codecProfile), Bitrate control mode * (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile. + * + * @var int|null */ private $bitrate; /** * AAC Profile. + * + * @var AacCodecProfile::*|null */ private $codecProfile; @@ -51,17 +57,23 @@ final class AacSettings * One channel, C. Includes audio description data from your stereo input. For more information see ETSI TS 101 154 * Annex E. * 1.0 Mono: One channel, C. * 2.0 Stereo: Two channels, L, R. * 5.1 Surround: Six channels, C, L, R, Ls, Rs, * LFE. + * + * @var AacCodingMode::*|null */ private $codingMode; /** * Rate Control Mode. + * + * @var AacRateControlMode::*|null */ private $rateControlMode; /** * Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for the * output container. + * + * @var AacRawFormat::*|null */ private $rawFormat; @@ -72,16 +84,22 @@ final class AacSettings * 32000, 44100, 48000, 96000. * HEV1 Profile, Coding mode 1.0 and Receiver Mix: 22050, 24000, 32000, 44100, 48000. * * HEV1 Profile, Coding mode 2.0 and 5.1: 32000, 44100, 48000, 96000. * HEV2 Profile, Coding mode 2.0: 22050, 24000, * 32000, 44100, 48000. + * + * @var int|null */ private $sampleRate; /** * Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. + * + * @var AacSpecification::*|null */ private $specification; /** * VBR Quality Level - Only used if rate_control_mode is VBR. + * + * @var AacVbrQuality::*|null */ private $vbrQuality; diff --git a/src/Service/MediaConvert/src/ValueObject/Ac3Settings.php b/src/Service/MediaConvert/src/ValueObject/Ac3Settings.php index f66013ef7..b653bbe33 100644 --- a/src/Service/MediaConvert/src/ValueObject/Ac3Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Ac3Settings.php @@ -23,22 +23,30 @@ final class Ac3Settings * for coding mode 1/1: Default: 192000. Minimum: 128000. Maximum: 384000. Valid bitrates for coding mode 2/0: Default: * 192000. Minimum: 128000. Maximum: 384000. Valid bitrates for coding mode 3/2 with FLE: Default: 384000. Minimum: * 384000. Maximum: 640000. + * + * @var int|null */ private $bitrate; /** * Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream * mode, see ATSC A/52-2012 (Annex E). + * + * @var Ac3BitstreamMode::*|null */ private $bitstreamMode; /** * Dolby Digital coding mode. Determines number of channels. + * + * @var Ac3CodingMode::*|null */ private $codingMode; /** * Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through. + * + * @var int|null */ private $dialnorm; @@ -48,6 +56,8 @@ final class Ac3Settings * any value you provide for Dynamic range compression profile (DynamicRangeCompressionProfile). For information about * the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide * at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. + * + * @var Ac3DynamicRangeCompressionLine::*|null */ private $dynamicRangeCompressionLine; @@ -59,6 +69,8 @@ final class Ac3Settings * settings, MediaConvert ignores the value of this setting in favor of the mode-specific settings. If you do use this * setting instead of the mode-specific settings, choose None (NONE) to leave out DRC signaling. Keep the default Film * standard (FILM_STANDARD) to set the profile to Dolby's film standard profile for all operating modes. + * + * @var Ac3DynamicRangeCompressionProfile::*|null */ private $dynamicRangeCompressionProfile; @@ -68,22 +80,30 @@ final class Ac3Settings * value you provide for Dynamic range compression profile (DynamicRangeCompressionProfile). For information about the * Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at * https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. + * + * @var Ac3DynamicRangeCompressionRf::*|null */ private $dynamicRangeCompressionRf; /** * Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode. + * + * @var Ac3LfeFilter::*|null */ private $lfeFilter; /** * When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this * audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. + * + * @var Ac3MetadataControl::*|null */ private $metadataControl; /** * This value is always 48000. It represents the sample rate in Hz. + * + * @var int|null */ private $sampleRate; diff --git a/src/Service/MediaConvert/src/ValueObject/AccelerationSettings.php b/src/Service/MediaConvert/src/ValueObject/AccelerationSettings.php index c710bfd82..cee922a47 100644 --- a/src/Service/MediaConvert/src/ValueObject/AccelerationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AccelerationSettings.php @@ -12,6 +12,8 @@ final class AccelerationSettings { /** * Specify the conditions when the service will run your job with accelerated transcoding. + * + * @var AccelerationMode::* */ private $mode; diff --git a/src/Service/MediaConvert/src/ValueObject/AdvancedInputFilterSettings.php b/src/Service/MediaConvert/src/ValueObject/AdvancedInputFilterSettings.php index 0cab43fe9..e6762445c 100644 --- a/src/Service/MediaConvert/src/ValueObject/AdvancedInputFilterSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AdvancedInputFilterSettings.php @@ -16,6 +16,8 @@ final class AdvancedInputFilterSettings * To adaptively add texture and reduce softness: Choose Enabled. To not add any texture: Keep the default value, * Disabled. We recommend that you choose Disabled for input video content that doesn't have texture, including screen * recordings, computer graphics, or cartoons. + * + * @var AdvancedInputFilterAddTexture::*|null */ private $addTexture; @@ -23,6 +25,8 @@ final class AdvancedInputFilterSettings * Optionally specify the amount of sharpening to apply when you use the Advanced input filter. Sharpening adds contrast * to the edges of your video content and can reduce softness. To apply no sharpening: Keep the default value, Off. To * apply a minimal amount of sharpening choose Low, or for the maximum choose High. + * + * @var AdvancedInputFilterSharpen::*|null */ private $sharpening; diff --git a/src/Service/MediaConvert/src/ValueObject/AiffSettings.php b/src/Service/MediaConvert/src/ValueObject/AiffSettings.php index 2f5c14659..ec48d092a 100644 --- a/src/Service/MediaConvert/src/ValueObject/AiffSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AiffSettings.php @@ -9,17 +9,23 @@ final class AiffSettings { /** * Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track. + * + * @var int|null */ private $bitDepth; /** * Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, * 1, 2, 4, 6, and so on, up to 64. + * + * @var int|null */ private $channels; /** * Sample rate in hz. + * + * @var int|null */ private $sampleRate; diff --git a/src/Service/MediaConvert/src/ValueObject/AllowedRenditionSize.php b/src/Service/MediaConvert/src/ValueObject/AllowedRenditionSize.php index 3b04e9de0..45a586f9b 100644 --- a/src/Service/MediaConvert/src/ValueObject/AllowedRenditionSize.php +++ b/src/Service/MediaConvert/src/ValueObject/AllowedRenditionSize.php @@ -17,16 +17,22 @@ final class AllowedRenditionSize { /** * Use Height to define the video resolution height, in pixels, for this rule. + * + * @var int|null */ private $height; /** * Set to ENABLED to force a rendition to be included. + * + * @var RequiredFlag::*|null */ private $required; /** * Use Width to define the video resolution width, in pixels, for this rule. + * + * @var int|null */ private $width; diff --git a/src/Service/MediaConvert/src/ValueObject/AncillarySourceSettings.php b/src/Service/MediaConvert/src/ValueObject/AncillarySourceSettings.php index 615461785..92fa73e59 100644 --- a/src/Service/MediaConvert/src/ValueObject/AncillarySourceSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AncillarySourceSettings.php @@ -15,17 +15,23 @@ final class AncillarySourceSettings * Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose * Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the * 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708. + * + * @var AncillaryConvert608To708::*|null */ private $convert608To708; /** * Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough. + * + * @var int|null */ private $sourceAncillaryChannelNumber; /** * By default, the service terminates any unterminated captions at the end of each input. If you want the caption to * continue onto your next input, disable this setting. + * + * @var AncillaryTerminateCaptions::*|null */ private $terminateCaptions; diff --git a/src/Service/MediaConvert/src/ValueObject/AudioChannelTaggingSettings.php b/src/Service/MediaConvert/src/ValueObject/AudioChannelTaggingSettings.php index 3abe430b9..2462a49f9 100644 --- a/src/Service/MediaConvert/src/ValueObject/AudioChannelTaggingSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AudioChannelTaggingSettings.php @@ -17,6 +17,8 @@ final class AudioChannelTaggingSettings /** * You can add a tag for this mono-channel audio track to mimic its placement in a multi-channel layout. For example, if * this track is the left surround channel, choose Left surround (LS). + * + * @var AudioChannelTag::*|null */ private $channelTag; diff --git a/src/Service/MediaConvert/src/ValueObject/AudioCodecSettings.php b/src/Service/MediaConvert/src/ValueObject/AudioCodecSettings.php index c99a57fa2..8b25a1ca8 100644 --- a/src/Service/MediaConvert/src/ValueObject/AudioCodecSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AudioCodecSettings.php @@ -17,16 +17,22 @@ final class AudioCodecSettings * control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR * quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the * rate control mode. + * + * @var AacSettings|null */ private $aacSettings; /** * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3. + * + * @var Ac3Settings|null */ private $ac3Settings; /** * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF. + * + * @var AiffSettings|null */ private $aiffSettings; @@ -39,41 +45,57 @@ final class AudioCodecSettings * audio-only workflows. For more information, see: * https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html#reference-codecs-containers-input-audio-only * and https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#audio-only-output. + * + * @var AudioCodec::*|null */ private $codec; /** * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS. + * + * @var Eac3AtmosSettings|null */ private $eac3AtmosSettings; /** * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3. + * + * @var Eac3Settings|null */ private $eac3Settings; /** * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2. + * + * @var Mp2Settings|null */ private $mp2Settings; /** * Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3. + * + * @var Mp3Settings|null */ private $mp3Settings; /** * Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS. + * + * @var OpusSettings|null */ private $opusSettings; /** * Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis. + * + * @var VorbisSettings|null */ private $vorbisSettings; /** * Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV. + * + * @var WavSettings|null */ private $wavSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/AudioDescription.php b/src/Service/MediaConvert/src/ValueObject/AudioDescription.php index 183209f50..38a9dbca9 100644 --- a/src/Service/MediaConvert/src/ValueObject/AudioDescription.php +++ b/src/Service/MediaConvert/src/ValueObject/AudioDescription.php @@ -21,11 +21,15 @@ final class AudioDescription * (R), and Center (C), respectively. When you don't specify a value, MediaConvert labels your track as Center (C) by * default. To use audio layout tagging, your output must be in a QuickTime (.mov) container; your audio codec must be * AAC, WAV, or AIFF; and you must set up your audio track to have only one channel. + * + * @var AudioChannelTaggingSettings|null */ private $audioChannelTaggingSettings; /** * Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard. + * + * @var AudioNormalizationSettings|null */ private $audioNormalizationSettings; @@ -37,6 +41,8 @@ final class AudioDescription * "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector * Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no * audio_source_name is specified, then "Audio Selector 1" will be chosen automatically. + * + * @var string|null */ private $audioSourceName; @@ -44,6 +50,8 @@ final class AudioDescription * Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined * in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = * Reserved. + * + * @var int|null */ private $audioType; @@ -52,12 +60,16 @@ final class AudioDescription * output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the * value in Audio Type is included in the output. Note that this field and audioType are both ignored if * audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD. + * + * @var AudioTypeControl::*|null */ private $audioTypeControl; /** * Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your * audio codec. + * + * @var AudioCodecSettings|null */ private $codecSettings; @@ -69,6 +81,8 @@ final class AudioDescription * or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. * Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft * Smooth Streaming. + * + * @var string|null */ private $customLanguageCode; @@ -76,6 +90,8 @@ final class AudioDescription * Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down * will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but * there is no ISO 639 language code specified by the input. + * + * @var LanguageCode::*|null */ private $languageCode; @@ -85,11 +101,15 @@ final class AudioDescription * on the input track, the service uses the code that you specify in the setting Language code (languageCode or * customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you * specify. + * + * @var AudioLanguageCodeControl::*|null */ private $languageCodeControl; /** * Advanced audio remixing settings. + * + * @var RemixSettings|null */ private $remixSettings; @@ -97,6 +117,8 @@ final class AudioDescription * Specify a label for this output audio stream. For example, "English", "Director commentary", or "track_2". For * streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's * player device. For outputs in other output groups, the service ignores this setting. + * + * @var string|null */ private $streamName; diff --git a/src/Service/MediaConvert/src/ValueObject/AudioNormalizationSettings.php b/src/Service/MediaConvert/src/ValueObject/AudioNormalizationSettings.php index 26494fb6f..1f48ec92c 100644 --- a/src/Service/MediaConvert/src/ValueObject/AudioNormalizationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AudioNormalizationSettings.php @@ -21,28 +21,38 @@ final class AudioNormalizationSettings * Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R * BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations * such as 7.1. + * + * @var AudioNormalizationAlgorithm::*|null */ private $algorithm; /** * When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but * not adjusted. + * + * @var AudioNormalizationAlgorithmControl::*|null */ private $algorithmControl; /** * Content measuring above this level will be corrected to the target level. Content measuring below this level will not * be corrected. + * + * @var int|null */ private $correctionGateLevel; /** * If set to LOG, log each output's audio track loudness to a CSV file. + * + * @var AudioNormalizationLoudnessLogging::*|null */ private $loudnessLogging; /** * If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness. + * + * @var AudioNormalizationPeakCalculation::*|null */ private $peakCalculation; @@ -51,6 +61,8 @@ final class AudioNormalizationSettings * loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you * choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the * encoder will choose -23 LKFS. + * + * @var float|null */ private $targetLkfs; @@ -58,6 +70,8 @@ final class AudioNormalizationSettings * Specify the True-peak limiter threshold in decibels relative to full scale (dBFS). The peak inter-audio sample * loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. * Enter a value from 0 to -8. Leave blank to use the default value 0. + * + * @var float|null */ private $truePeakLimiterThreshold; diff --git a/src/Service/MediaConvert/src/ValueObject/AudioSelector.php b/src/Service/MediaConvert/src/ValueObject/AudioSelector.php index ac130a086..4c5e9d305 100644 --- a/src/Service/MediaConvert/src/ValueObject/AudioSelector.php +++ b/src/Service/MediaConvert/src/ValueObject/AudioSelector.php @@ -24,23 +24,31 @@ final class AudioSelector * tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align * audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may * affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion. + * + * @var AudioDurationCorrection::*|null */ private $audioDurationCorrection; /** * Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language * code. + * + * @var string|null */ private $customLanguageCode; /** * Enable this setting on one audio selector to set it as the default for the job. The service uses this default for * outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio. + * + * @var AudioDefaultSelection::*|null */ private $defaultSelection; /** * Specifies audio data from an external file source. + * + * @var string|null */ private $externalAudioFileInput; @@ -50,21 +58,29 @@ final class AudioSelector * present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job * fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment * is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead. + * + * @var HlsRenditionGroupSettings|null */ private $hlsRenditionGroupSettings; /** * Selects a specific language code from within an audio source. + * + * @var LanguageCode::*|null */ private $languageCode; /** * Specifies a time delta in milliseconds to offset the audio from the input video. + * + * @var int|null */ private $offset; /** * Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101). + * + * @var int[]|null */ private $pids; @@ -75,17 +91,23 @@ final class AudioSelector * list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file * has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the * program IDs and include all the programs in the track. + * + * @var int|null */ private $programSelection; /** * Use these settings to reorder the audio channels of one input to match those of another input. This allows you to * combine the two files into a single output, one after the other. + * + * @var RemixSettings|null */ private $remixSettings; /** * Specifies the type of the audio selector. + * + * @var AudioSelectorType::*|null */ private $selectorType; @@ -94,6 +116,8 @@ final class AudioSelector * several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a * comma-separated list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying directly in your JSON job * file, provide the track numbers in an array. For example, "tracks": [1,2,3]. + * + * @var int[]|null */ private $tracks; diff --git a/src/Service/MediaConvert/src/ValueObject/AudioSelectorGroup.php b/src/Service/MediaConvert/src/ValueObject/AudioSelectorGroup.php index 576190b70..d6e8df178 100644 --- a/src/Service/MediaConvert/src/ValueObject/AudioSelectorGroup.php +++ b/src/Service/MediaConvert/src/ValueObject/AudioSelectorGroup.php @@ -13,6 +13,8 @@ final class AudioSelectorGroup * Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized, based * on their order within the input (e.g., "Audio Selector 1"). The audio selector name parameter can be repeated to add * any number of audio selectors to the group. + * + * @var string[]|null */ private $audioSelectorNames; diff --git a/src/Service/MediaConvert/src/ValueObject/AutomatedAbrRule.php b/src/Service/MediaConvert/src/ValueObject/AutomatedAbrRule.php index f53182e3b..35602a60c 100644 --- a/src/Service/MediaConvert/src/ValueObject/AutomatedAbrRule.php +++ b/src/Service/MediaConvert/src/ValueObject/AutomatedAbrRule.php @@ -13,12 +13,16 @@ final class AutomatedAbrRule /** * When customer adds the allowed renditions rule for auto ABR ladder, they are required to add at leat one rendition to * allowedRenditions list. + * + * @var AllowedRenditionSize[]|null */ private $allowedRenditions; /** * When customer adds the force include renditions rule for auto ABR ladder, they are required to add at leat one * rendition to forceIncludeRenditions list. + * + * @var ForceIncludeRenditionSize[]|null */ private $forceIncludeRenditions; @@ -28,6 +32,8 @@ final class AutomatedAbrRule * 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min * top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min * top rendition size. + * + * @var MinBottomRenditionSize|null */ private $minBottomRenditionSize; @@ -37,6 +43,8 @@ final class AutomatedAbrRule * 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value * for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max * resolution. + * + * @var MinTopRenditionSize|null */ private $minTopRenditionSize; @@ -63,6 +71,8 @@ final class AutomatedAbrRule * Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that * you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not * specify a separate rule for Force include renditions. + * + * @var RuleType::*|null */ private $type; diff --git a/src/Service/MediaConvert/src/ValueObject/AutomatedAbrSettings.php b/src/Service/MediaConvert/src/ValueObject/AutomatedAbrSettings.php index d14cb09f8..abdafcc25 100644 --- a/src/Service/MediaConvert/src/ValueObject/AutomatedAbrSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AutomatedAbrSettings.php @@ -13,6 +13,8 @@ final class AutomatedAbrSettings * Optional. The maximum target bit rate used in your automated ABR stack. Use this value to set an upper limit on the * bandwidth consumed by the highest-quality rendition. This is the rendition that is delivered to viewers with the * fastest internet connections. If you don't specify a value, MediaConvert uses 8,000,000 (8 mb/s) by default. + * + * @var int|null */ private $maxAbrBitrate; @@ -21,6 +23,8 @@ final class AutomatedAbrSettings * renditions is determined automatically, based on analysis of each job, but will never exceed this limit. When you set * this to Auto in the console, which is equivalent to excluding it from your JSON job specification, MediaConvert * defaults to a limit of 15. + * + * @var int|null */ private $maxRenditions; @@ -28,6 +32,8 @@ final class AutomatedAbrSettings * Optional. The minimum target bitrate used in your automated ABR stack. Use this value to set a lower limit on the * bitrate of video delivered to viewers with slow internet connections. If you don't specify a value, MediaConvert uses * 600,000 (600 kb/s) by default. + * + * @var int|null */ private $minAbrBitrate; @@ -35,6 +41,8 @@ final class AutomatedAbrSettings * Optional. Use Automated ABR rules to specify restrictions for the rendition sizes MediaConvert will create in your * ABR stack. You can use these rules if your ABR workflow has specific rendition size requirements, but you still want * MediaConvert to optimize for video quality and overall file size. + * + * @var AutomatedAbrRule[]|null */ private $rules; diff --git a/src/Service/MediaConvert/src/ValueObject/AutomatedEncodingSettings.php b/src/Service/MediaConvert/src/ValueObject/AutomatedEncodingSettings.php index 932e8216a..6cede296b 100644 --- a/src/Service/MediaConvert/src/ValueObject/AutomatedEncodingSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AutomatedEncodingSettings.php @@ -12,6 +12,8 @@ final class AutomatedEncodingSettings * Use automated ABR to have MediaConvert set up the renditions in your ABR package for you automatically, based on * characteristics of your input video. This feature optimizes video quality while minimizing the overall size of your * ABR package. + * + * @var AutomatedAbrSettings|null */ private $abrSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/Av1QvbrSettings.php b/src/Service/MediaConvert/src/ValueObject/Av1QvbrSettings.php index a92cbbaef..c507b2113 100644 --- a/src/Service/MediaConvert/src/ValueObject/Av1QvbrSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/Av1QvbrSettings.php @@ -17,6 +17,8 @@ final class Av1QvbrSettings * broadcast-quality transcodes is between 6 and 9. Optionally, to specify a value between whole numbers, also provide a * value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set * qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. + * + * @var int|null */ private $qvbrQualityLevel; @@ -25,6 +27,8 @@ final class Av1QvbrSettings * want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. * MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set * qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. + * + * @var float|null */ private $qvbrQualityLevelFineTune; diff --git a/src/Service/MediaConvert/src/ValueObject/Av1Settings.php b/src/Service/MediaConvert/src/ValueObject/Av1Settings.php index 3331d25b2..925c9611f 100644 --- a/src/Service/MediaConvert/src/ValueObject/Av1Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Av1Settings.php @@ -18,11 +18,15 @@ final class Av1Settings /** * Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to * Spatial adaptive quantization (spatialAdaptiveQuantization). + * + * @var Av1AdaptiveQuantization::*|null */ private $adaptiveQuantization; /** * Specify the Bit depth (Av1BitDepth). You can choose 8-bit (BIT_8) or 10-bit (BIT_10). + * + * @var Av1BitDepth::*|null */ private $bitDepth; @@ -35,6 +39,8 @@ final class Av1Settings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var Av1FramerateControl::*|null */ private $framerateControl; @@ -47,6 +53,8 @@ final class Av1Settings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var Av1FramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -55,6 +63,8 @@ final class Av1Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -63,6 +73,8 @@ final class Av1Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; @@ -70,30 +82,40 @@ final class Av1Settings * Specify the GOP length (keyframe interval) in frames. With AV1, MediaConvert doesn't support GOP length in seconds. * This value must be greater than zero and preferably equal to 1 + ((numberBFrames + 1) * x), where x is an integer * value. + * + * @var float|null */ private $gopSize; /** * Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control * mode is QVBR. + * + * @var int|null */ private $maxBitrate; /** * Specify from the number of B-frames, in the range of 0-15. For AV1 encoding, we recommend using 7 or 15. Choose a * larger number for a lower bitrate and smaller file size; choose a smaller number for better video quality. + * + * @var int|null */ private $numberBframesBetweenReferenceFrames; /** * Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set * QVBR for Rate control mode (RateControlMode). + * + * @var Av1QvbrSettings|null */ private $qvbrSettings; /** * 'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You * can''t use CBR or VBR.'. + * + * @var Av1RateControlMode::*|null */ private $rateControlMode; @@ -101,6 +123,8 @@ final class Av1Settings * Specify the number of slices per picture. This value must be 1, 2, 4, 8, 16, or 32. For progressive pictures, this * value must be less than or equal to the number of macroblock rows. For interlaced pictures, this value must be less * than or equal to half the number of macroblock rows. + * + * @var int|null */ private $slices; @@ -115,6 +139,8 @@ final class Av1Settings * setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization * (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it * to Low. For content with a wider variety of textures, set it to High or Higher. + * + * @var Av1SpatialAdaptiveQuantization::*|null */ private $spatialAdaptiveQuantization; diff --git a/src/Service/MediaConvert/src/ValueObject/AvailBlanking.php b/src/Service/MediaConvert/src/ValueObject/AvailBlanking.php index 873331c28..66b36b513 100644 --- a/src/Service/MediaConvert/src/ValueObject/AvailBlanking.php +++ b/src/Service/MediaConvert/src/ValueObject/AvailBlanking.php @@ -11,6 +11,8 @@ final class AvailBlanking { /** * Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. + * + * @var string|null */ private $availBlankingImage; diff --git a/src/Service/MediaConvert/src/ValueObject/AvcIntraSettings.php b/src/Service/MediaConvert/src/ValueObject/AvcIntraSettings.php index 11dfdcd8f..eb33e7195 100644 --- a/src/Service/MediaConvert/src/ValueObject/AvcIntraSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AvcIntraSettings.php @@ -23,12 +23,16 @@ final class AvcIntraSettings * Specify the AVC-Intra class of your output. The AVC-Intra class selection determines the output video bit rate * depending on the frame rate of the output. Outputs with higher class values have higher bitrates and improved image * quality. Note that for Class 4K/2K, MediaConvert supports only 4:2:2 chroma subsampling. + * + * @var AvcIntraClass::*|null */ private $avcIntraClass; /** * Optional when you set AVC-Intra class (avcIntraClass) to Class 4K/2K (CLASS_4K_2K). When you set AVC-Intra class to a * different value, this object isn't allowed. + * + * @var AvcIntraUhdSettings|null */ private $avcIntraUhdSettings; @@ -41,6 +45,8 @@ final class AvcIntraSettings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var AvcIntraFramerateControl::*|null */ private $framerateControl; @@ -53,6 +59,8 @@ final class AvcIntraSettings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var AvcIntraFramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -61,6 +69,8 @@ final class AvcIntraSettings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -69,6 +79,8 @@ final class AvcIntraSettings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; @@ -81,6 +93,8 @@ final class AvcIntraSettings * Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the * same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field * first, depending on which of the Follow options you choose. + * + * @var AvcIntraInterlaceMode::*|null */ private $interlaceMode; @@ -94,6 +108,8 @@ final class AvcIntraSettings * basic interlacing. Required settings: To use optimized interlacing, you must set Telecine (telecine) to None (NONE) * or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode * (interlaceMode) to a value other than Progressive (PROGRESSIVE). + * + * @var AvcIntraScanTypeConversionMode::*|null */ private $scanTypeConversionMode; @@ -103,6 +119,8 @@ final class AvcIntraSettings * keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. * Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to * (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. + * + * @var AvcIntraSlowPal::*|null */ private $slowPal; @@ -111,6 +129,8 @@ final class AvcIntraSettings * interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default * value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field * polarity to create a smoother picture. + * + * @var AvcIntraTelecine::*|null */ private $telecine; diff --git a/src/Service/MediaConvert/src/ValueObject/AvcIntraUhdSettings.php b/src/Service/MediaConvert/src/ValueObject/AvcIntraUhdSettings.php index 92384ffd2..157e855c1 100644 --- a/src/Service/MediaConvert/src/ValueObject/AvcIntraUhdSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/AvcIntraUhdSettings.php @@ -17,6 +17,8 @@ final class AvcIntraUhdSettings * accurate. That is, the actual bitrate of your output is closer to the target bitrate defined in the specification. * When you choose Single-pass (SINGLE_PASS), your encoding time is faster. The default behavior is Single-pass * (SINGLE_PASS). + * + * @var AvcIntraUhdQualityTuningLevel::*|null */ private $qualityTuningLevel; diff --git a/src/Service/MediaConvert/src/ValueObject/BandwidthReductionFilter.php b/src/Service/MediaConvert/src/ValueObject/BandwidthReductionFilter.php index 77f4066c7..c9e27ce05 100644 --- a/src/Service/MediaConvert/src/ValueObject/BandwidthReductionFilter.php +++ b/src/Service/MediaConvert/src/ValueObject/BandwidthReductionFilter.php @@ -20,6 +20,8 @@ final class BandwidthReductionFilter * contrast to the edges of your video content and can reduce softness. Keep the default value Off to apply no * sharpening. Set Sharpening strength to Low to apply a minimal amount of sharpening, or High to apply a maximum amount * of sharpening. + * + * @var BandwidthReductionFilterSharpening::*|null */ private $sharpening; @@ -28,6 +30,8 @@ final class BandwidthReductionFilter * reduce the bandwidth of your output with little to no perceptual decrease in video quality. For high quality and high * bitrate outputs, choose Low. For the most bandwidth reduction, choose High. We recommend that you choose High for low * bitrate outputs. Note that High may incur a slight increase in the softness of your output. + * + * @var BandwidthReductionFilterStrength::*|null */ private $strength; diff --git a/src/Service/MediaConvert/src/ValueObject/BurninDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/BurninDestinationSettings.php index db1170c13..efa1a54e7 100644 --- a/src/Service/MediaConvert/src/ValueObject/BurninDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/BurninDestinationSettings.php @@ -28,6 +28,8 @@ final class BurninDestinationSettings * placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the * bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will * be justified (either left or centered) relative to those coordinates. + * + * @var BurninSubtitleAlignment::*|null */ private $alignment; @@ -38,12 +40,16 @@ final class BurninDestinationSettings * in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white * text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies * to all of your output captions text. + * + * @var BurninSubtitleApplyFontColor::*|null */ private $applyFontColor; /** * Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style * passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present. + * + * @var BurninSubtitleBackgroundColor::*|null */ private $backgroundColor; @@ -52,6 +58,8 @@ final class BurninDestinationSettings * opaque. If Style passthrough (StylePassthrough) is set to enabled, leave blank to pass through the background style * information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to * use a value of 0 and remove all backgrounds from your output captions. + * + * @var int|null */ private $backgroundOpacity; @@ -62,22 +70,30 @@ final class BurninDestinationSettings * there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font * that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all * unsupported fonts from your input. + * + * @var BurninSubtitleFallbackFont::*|null */ private $fallbackFont; /** * Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough * (StylePassthrough) to enabled to use the font color data from your input captions, if present. + * + * @var BurninSubtitleFontColor::*|null */ private $fontColor; /** * Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent. + * + * @var int|null */ private $fontOpacity; /** * Specify the Font resolution (FontResolution) in DPI (dots per inch). + * + * @var int|null */ private $fontResolution; @@ -85,12 +101,16 @@ final class BurninDestinationSettings * Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the * font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your * input font script uses Simplified or Traditional Chinese. + * + * @var FontScript::*|null */ private $fontScript; /** * Specify the Font size (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font * size. + * + * @var int|null */ private $fontSize; @@ -98,24 +118,32 @@ final class BurninDestinationSettings * Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing * red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of * 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB. + * + * @var string|null */ private $hexFontColor; /** * Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to * enabled to use the font outline color data from your input captions, if present. + * + * @var BurninSubtitleOutlineColor::*|null */ private $outlineColor; /** * Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style * passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present. + * + * @var int|null */ private $outlineSize; /** * Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style * passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present. + * + * @var BurninSubtitleShadowColor::*|null */ private $shadowColor; @@ -124,12 +152,16 @@ final class BurninDestinationSettings * passthrough (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through the * shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, * leave blank to use a value of 0 and remove all shadows from your output captions. + * + * @var int|null */ private $shadowOpacity; /** * Specify the horizontal offset of the shadow, relative to the captions in pixels. A value of -2 would result in a * shadow offset 2 pixels to the left. + * + * @var int|null */ private $shadowXoffset; @@ -137,6 +169,8 @@ final class BurninDestinationSettings * Specify the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow * offset 2 pixels above the text. Leave Shadow y-offset (ShadowYOffset) blank and set Style passthrough * (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present. + * + * @var int|null */ private $shadowYoffset; @@ -147,6 +181,8 @@ final class BurninDestinationSettings * input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic * sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the * individual style and position settings. + * + * @var BurnInSubtitleStylePassthrough::*|null */ private $stylePassthrough; @@ -154,6 +190,8 @@ final class BurninDestinationSettings * Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending * on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more * accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. + * + * @var BurninSubtitleTeletextSpacing::*|null */ private $teletextSpacing; @@ -161,6 +199,8 @@ final class BurninDestinationSettings * Specify the horizontal position (XPosition) of the captions, relative to the left side of the output in pixels. A * value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is * provided, the horizontal caption position will be determined by the alignment parameter. + * + * @var int|null */ private $xposition; @@ -168,6 +208,8 @@ final class BurninDestinationSettings * Specify the vertical position (YPosition) of the captions, relative to the top of the output in pixels. A value of 10 * would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, * the caption will be positioned towards the bottom of the output. + * + * @var int|null */ private $yposition; diff --git a/src/Service/MediaConvert/src/ValueObject/CaptionDescription.php b/src/Service/MediaConvert/src/ValueObject/CaptionDescription.php index 72c996ce5..ce46db5e9 100644 --- a/src/Service/MediaConvert/src/ValueObject/CaptionDescription.php +++ b/src/Service/MediaConvert/src/ValueObject/CaptionDescription.php @@ -15,6 +15,8 @@ final class CaptionDescription * Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name * should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each * input. + * + * @var string|null */ private $captionSelectorName; @@ -25,6 +27,8 @@ final class CaptionDescription * outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the * full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH * ISO, Apple HLS, or Microsoft Smooth Streaming. + * + * @var string|null */ private $customLanguageCode; @@ -33,6 +37,8 @@ final class CaptionDescription * DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one * output captions track. Depending on your output captions format, one tab might correspond to a set of output captions * tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html. + * + * @var CaptionDestinationSettings|null */ private $destinationSettings; @@ -40,6 +46,8 @@ final class CaptionDescription * Specify the language of this captions output track. For most captions output formats, the encoder puts this language * information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses * this language information to choose the font language for rendering the captions text. + * + * @var LanguageCode::*|null */ private $languageCode; @@ -47,6 +55,8 @@ final class CaptionDescription * Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For * streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's * player device. For outputs in other output groups, the service ignores this setting. + * + * @var string|null */ private $languageDescription; diff --git a/src/Service/MediaConvert/src/ValueObject/CaptionDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/CaptionDestinationSettings.php index a780a81e5..92f56195b 100644 --- a/src/Service/MediaConvert/src/ValueObject/CaptionDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/CaptionDestinationSettings.php @@ -19,6 +19,8 @@ final class CaptionDestinationSettings * video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. * When you work directly in your JSON job specification, include this object and any required children when you set * destinationType to BURN_IN. + * + * @var BurninDestinationSettings|null */ private $burninDestinationSettings; @@ -29,6 +31,8 @@ final class CaptionDestinationSettings * want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To * create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 * (EMBEDDED_PLUS_SCTE20). + * + * @var CaptionDestinationType::*|null */ private $destinationType; @@ -36,6 +40,8 @@ final class CaptionDestinationSettings * Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, * see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your * JSON job specification, include this object and any required children when you set destinationType to DVB_SUB. + * + * @var DvbSubDestinationSettings|null */ private $dvbSubDestinationSettings; @@ -45,6 +51,8 @@ final class CaptionDestinationSettings * https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON * job specification, include this object and any required children when you set destinationType to EMBEDDED, * EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED. + * + * @var EmbeddedDestinationSettings|null */ private $embeddedDestinationSettings; @@ -54,6 +62,8 @@ final class CaptionDestinationSettings * information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you * work directly in your JSON job specification, include this object and any required children when you set * destinationType to IMSC. + * + * @var ImscDestinationSettings|null */ private $imscDestinationSettings; @@ -63,6 +73,8 @@ final class CaptionDestinationSettings * information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work * directly in your JSON job specification, include this object and any required children when you set destinationType * to SCC. + * + * @var SccDestinationSettings|null */ private $sccDestinationSettings; @@ -71,6 +83,8 @@ final class CaptionDestinationSettings * video container. Set up sidecar captions in the same output group, but different output from your video. When you * work directly in your JSON job specification, include this object and any required children when you set * destinationType to SRT. + * + * @var SrtDestinationSettings|null */ private $srtDestinationSettings; @@ -79,6 +93,8 @@ final class CaptionDestinationSettings * information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. When you work * directly in your JSON job specification, include this object and any required children when you set destinationType * to TELETEXT. + * + * @var TeletextDestinationSettings|null */ private $teletextDestinationSettings; @@ -88,6 +104,8 @@ final class CaptionDestinationSettings * information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you * work directly in your JSON job specification, include this object and any required children when you set * destinationType to TTML. + * + * @var TtmlDestinationSettings|null */ private $ttmlDestinationSettings; @@ -97,6 +115,8 @@ final class CaptionDestinationSettings * information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you * work directly in your JSON job specification, include this object and any required children when you set * destinationType to WebVTT. + * + * @var WebvttDestinationSettings|null */ private $webvttDestinationSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/CaptionSelector.php b/src/Service/MediaConvert/src/ValueObject/CaptionSelector.php index 6abb39e03..8e7dc1c38 100644 --- a/src/Service/MediaConvert/src/ValueObject/CaptionSelector.php +++ b/src/Service/MediaConvert/src/ValueObject/CaptionSelector.php @@ -17,6 +17,8 @@ final class CaptionSelector * is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub * that is being passed through, omit this field (and PID field); there is no way to extract a specific language with * pass-through captions. + * + * @var string|null */ private $customLanguageCode; @@ -25,12 +27,16 @@ final class CaptionSelector * caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to * select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID * field); there is no way to extract a specific language with pass-through captions. + * + * @var LanguageCode::*|null */ private $languageCode; /** * If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions * source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings. + * + * @var CaptionSourceSettings|null */ private $sourceSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/CaptionSourceFramerate.php b/src/Service/MediaConvert/src/ValueObject/CaptionSourceFramerate.php index 877b6fffb..e6086e3e7 100644 --- a/src/Service/MediaConvert/src/ValueObject/CaptionSourceFramerate.php +++ b/src/Service/MediaConvert/src/ValueObject/CaptionSourceFramerate.php @@ -14,12 +14,16 @@ final class CaptionSourceFramerate /** * Specify the denominator of the fraction that represents the frame rate for the setting Caption source frame rate * (CaptionSourceFramerate). Use this setting along with the setting Framerate numerator (framerateNumerator). + * + * @var int|null */ private $framerateDenominator; /** * Specify the numerator of the fraction that represents the frame rate for the setting Caption source frame rate * (CaptionSourceFramerate). Use this setting along with the setting Framerate denominator (framerateDenominator). + * + * @var int|null */ private $framerateNumerator; diff --git a/src/Service/MediaConvert/src/ValueObject/CaptionSourceSettings.php b/src/Service/MediaConvert/src/ValueObject/CaptionSourceSettings.php index 25254f745..782ffbf00 100644 --- a/src/Service/MediaConvert/src/ValueObject/CaptionSourceSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/CaptionSourceSettings.php @@ -13,16 +13,22 @@ final class CaptionSourceSettings { /** * Settings for ancillary captions source. + * + * @var AncillarySourceSettings|null */ private $ancillarySourceSettings; /** * DVB Sub Source Settings. + * + * @var DvbSubSourceSettings|null */ private $dvbSubSourceSettings; /** * Settings for embedded captions Source. + * + * @var EmbeddedSourceSettings|null */ private $embeddedSourceSettings; @@ -30,16 +36,22 @@ final class CaptionSourceSettings * If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input * caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of * FileSoureSettings. + * + * @var FileSourceSettings|null */ private $fileSourceSettings; /** * Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format. + * + * @var CaptionSourceType::*|null */ private $sourceType; /** * Settings specific to Teletext caption sources, including Page number. + * + * @var TeletextSourceSettings|null */ private $teletextSourceSettings; @@ -47,6 +59,8 @@ final class CaptionSourceSettings * Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an * IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of * TrackSourceSettings. + * + * @var TrackSourceSettings|null */ private $trackSourceSettings; @@ -57,6 +71,8 @@ final class CaptionSourceSettings * fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default * subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of * WebvttHlsSourceSettings. + * + * @var WebvttHlsSourceSettings|null */ private $webvttHlsSourceSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/ChannelMapping.php b/src/Service/MediaConvert/src/ValueObject/ChannelMapping.php index f0b33802a..634bfad08 100644 --- a/src/Service/MediaConvert/src/ValueObject/ChannelMapping.php +++ b/src/Service/MediaConvert/src/ValueObject/ChannelMapping.php @@ -17,6 +17,8 @@ final class ChannelMapping /** * In your JSON job specification, include one child of OutputChannels for each audio channel that you want in your * output. Each child should contain one instance of InputChannels or InputChannelsFineTune. + * + * @var OutputChannelMapping[]|null */ private $outputChannels; diff --git a/src/Service/MediaConvert/src/ValueObject/ClipLimits.php b/src/Service/MediaConvert/src/ValueObject/ClipLimits.php index 890caec2b..6fd4dad45 100644 --- a/src/Service/MediaConvert/src/ValueObject/ClipLimits.php +++ b/src/Service/MediaConvert/src/ValueObject/ClipLimits.php @@ -12,6 +12,8 @@ final class ClipLimits * converted to RGB, would be outside the upper tolerance that you specify. Enter an integer from 90 to 105 as an offset * percentage to the maximum possible value. Leave blank to use the default value 100. When you specify a value for * Maximum RGB tolerance, you must set Sample range conversion to Limited range clip. + * + * @var int|null */ private $maximumRgbTolerance; @@ -20,6 +22,8 @@ final class ClipLimits * specify to typical limited range bounds. Enter an integer from 920 to 1023. Leave blank to use the default value 940. * The value that you enter applies to 10-bit ranges. For 8-bit ranges, MediaConvert automatically scales this value * down. When you specify a value for Maximum YUV, you must set Sample range conversion to Limited range clip. + * + * @var int|null */ private $maximumYuv; @@ -28,6 +32,8 @@ final class ClipLimits * converted to RGB, would be outside the lower tolerance that you specify. Enter an integer from -5 to 10 as an offset * percentage to the minimum possible value. Leave blank to use the default value 0. When you specify a value for * Minimum RGB tolerance, you must set Sample range conversion to Limited range clip. + * + * @var int|null */ private $minimumRgbTolerance; @@ -36,6 +42,8 @@ final class ClipLimits * specify to typical limited range bounds. Enter an integer from 0 to 128. Leave blank to use the default value 64. The * value that you enter applies to 10-bit ranges. For 8-bit ranges, MediaConvert automatically scales this value down. * When you specify a value for Minumum YUV, you must set Sample range conversion to Limited range clip. + * + * @var int|null */ private $minimumYuv; diff --git a/src/Service/MediaConvert/src/ValueObject/CmafAdditionalManifest.php b/src/Service/MediaConvert/src/ValueObject/CmafAdditionalManifest.php index 31d3940c5..7813fffa9 100644 --- a/src/Service/MediaConvert/src/ValueObject/CmafAdditionalManifest.php +++ b/src/Service/MediaConvert/src/ValueObject/CmafAdditionalManifest.php @@ -15,11 +15,15 @@ final class CmafAdditionalManifest * top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier that is * different from the nameModifier of the output. The service uses the output name modifier to create unique names for * the individual variant manifests. + * + * @var string|null */ private $manifestNameModifier; /** * Specify the outputs that you want this additional top-level manifest to reference. + * + * @var string[]|null */ private $selectedOutputs; diff --git a/src/Service/MediaConvert/src/ValueObject/CmafEncryptionSettings.php b/src/Service/MediaConvert/src/ValueObject/CmafEncryptionSettings.php index 875a3ff60..dfea3a520 100644 --- a/src/Service/MediaConvert/src/ValueObject/CmafEncryptionSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/CmafEncryptionSettings.php @@ -15,35 +15,47 @@ final class CmafEncryptionSettings /** * This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the * Initialization Vector will follow the segment number by default. + * + * @var string|null */ private $constantInitializationVector; /** * Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC * subsample (SAMPLE-AES) or AES_CTR (AES-CTR). + * + * @var CmafEncryptionType::*|null */ private $encryptionMethod; /** * When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in * the HLS and DASH manifests. + * + * @var CmafInitializationVectorInManifest::*|null */ private $initializationVectorInManifest; /** * If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. * If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead. + * + * @var SpekeKeyProviderCmaf|null */ private $spekeKeyProvider; /** * Use these settings to set up encryption with a static key provider. + * + * @var StaticKeyProvider|null */ private $staticKeyProvider; /** * Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more * information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. + * + * @var CmafKeyProviderType::*|null */ private $type; diff --git a/src/Service/MediaConvert/src/ValueObject/CmafGroupSettings.php b/src/Service/MediaConvert/src/ValueObject/CmafGroupSettings.php index 22d8d5495..dd03d0682 100644 --- a/src/Service/MediaConvert/src/ValueObject/CmafGroupSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/CmafGroupSettings.php @@ -34,12 +34,16 @@ final class CmafGroupSettings * output group in your job. These default manifests reference every output in the output group. To create additional * top-level manifests that reference a subset of the outputs in the output group, specify a list of them here. For each * additional manifest that you specify, the service creates one HLS manifest and one DASH manifest. + * + * @var CmafAdditionalManifest[]|null */ private $additionalManifests; /** * A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams * are delivered from a different URL than the manifest file. + * + * @var string|null */ private $baseUrl; @@ -47,11 +51,15 @@ final class CmafGroupSettings * Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default * value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control * http header. + * + * @var CmafClientCache::*|null */ private $clientCache; /** * Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. + * + * @var CmafCodecSpecification::*|null */ private $codecSpecification; @@ -61,6 +69,8 @@ final class CmafGroupSettings * Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any Representation that does not share a * common timeline. To write a video AdaptationSet for each different output framerate, and a common SegmentTimeline in * each AdaptationSet: Choose Distinct. + * + * @var DashManifestStyle::*|null */ private $dashManifestStyle; @@ -68,16 +78,22 @@ final class CmafGroupSettings * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts * format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the * input file. If your job has multiple inputs, the service uses the filename of the first input file. + * + * @var string|null */ private $destination; /** * Settings associated with the destination. Will vary based on the type of destination. + * + * @var DestinationSettings|null */ private $destinationSettings; /** * DRM settings. + * + * @var CmafEncryptionSettings|null */ private $encryption; @@ -85,6 +101,8 @@ final class CmafGroupSettings * Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to * 2. Related setting: Use Fragment length control (FragmentLengthControl) to specify whether the encoder enforces this * value strictly. + * + * @var int|null */ private $fragmentLength; @@ -98,26 +116,36 @@ final class CmafGroupSettings * these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are * compatible with this Roku specification: * https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md. + * + * @var CmafImageBasedTrickPlay::*|null */ private $imageBasedTrickPlay; /** * Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED. + * + * @var CmafImageBasedTrickPlaySettings|null */ private $imageBasedTrickPlaySettings; /** * When set to GZIP, compresses HLS playlist. + * + * @var CmafManifestCompression::*|null */ private $manifestCompression; /** * Indicates whether the output manifest should use floating point values for segment duration. + * + * @var CmafManifestDurationFormat::*|null */ private $manifestDurationFormat; /** * Minimum time of initially buffered media that is needed to ensure smooth playout. + * + * @var int|null */ private $minBufferTime; @@ -129,6 +157,8 @@ final class CmafGroupSettings * this setting, the encoder will combine any final segment that is shorter than the length that you specify with the * previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a * minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds. + * + * @var float|null */ private $minFinalSegmentLength; @@ -137,6 +167,8 @@ final class CmafGroupSettings * recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. * Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the * calculated average bitrate of the encoded video output, in bits per second. + * + * @var CmafMpdManifestBandwidthType::*|null */ private $mpdManifestBandwidthType; @@ -145,6 +177,8 @@ final class CmafGroupSettings * signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand * (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose * On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE). + * + * @var CmafMpdProfile::*|null */ private $mpdProfile; @@ -155,12 +189,16 @@ final class CmafGroupSettings * initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the * initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that * don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here. + * + * @var CmafPtsOffsetHandlingForBFrames::*|null */ private $ptsOffsetHandlingForBframes; /** * When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length * and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created. + * + * @var CmafSegmentControl::*|null */ private $segmentControl; @@ -169,6 +207,8 @@ final class CmafGroupSettings * Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this * value strictly. Use Segment control (CmafSegmentControl) to specify whether MediaConvert creates separate segment * files or one content file that has metadata to mark the segment boundaries. + * + * @var int|null */ private $segmentLength; @@ -177,11 +217,15 @@ final class CmafGroupSettings * exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. * Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP * boundary. + * + * @var CmafSegmentLengthControl::*|null */ private $segmentLengthControl; /** * Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. + * + * @var CmafStreamInfResolution::*|null */ private $streamInfResolution; @@ -192,6 +236,8 @@ final class CmafGroupSettings * may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual * duration of the segment. Some older players may experience interrupted playback when the actual duration of a track * in a segment is longer than the target duration. + * + * @var CmafTargetDurationCompatibilityMode::*|null */ private $targetDurationCompatibilityMode; @@ -201,16 +247,22 @@ final class CmafGroupSettings * and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, * set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition * time offsets will increment using signed integers. + * + * @var CmafVideoCompositionOffsets::*|null */ private $videoCompositionOffsets; /** * When set to ENABLED, a DASH MPD manifest will be generated for this output. + * + * @var CmafWriteDASHManifest::*|null */ private $writeDashManifest; /** * When set to ENABLED, an Apple HLS manifest will be generated for this output. + * + * @var CmafWriteHLSManifest::*|null */ private $writeHlsManifest; @@ -220,6 +272,8 @@ final class CmafGroupSettings * SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH * manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate * element. + * + * @var CmafWriteSegmentTimelineInRepresentation::*|null */ private $writeSegmentTimelineInRepresentation; diff --git a/src/Service/MediaConvert/src/ValueObject/CmafImageBasedTrickPlaySettings.php b/src/Service/MediaConvert/src/ValueObject/CmafImageBasedTrickPlaySettings.php index e066ae798..341941a7f 100644 --- a/src/Service/MediaConvert/src/ValueObject/CmafImageBasedTrickPlaySettings.php +++ b/src/Service/MediaConvert/src/ValueObject/CmafImageBasedTrickPlaySettings.php @@ -14,6 +14,8 @@ final class CmafImageBasedTrickPlaySettings * The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates * thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert * generates thumbnails according to the interval you specify in thumbnailInterval. + * + * @var CmafIntervalCadence::*|null */ private $intervalCadence; @@ -21,6 +23,8 @@ final class CmafImageBasedTrickPlaySettings * Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail * width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be * rejected. Must be divisible by 2. + * + * @var int|null */ private $thumbnailHeight; @@ -29,21 +33,29 @@ final class CmafImageBasedTrickPlaySettings * align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. * For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame * interval to generate thumbnails. + * + * @var float|null */ private $thumbnailInterval; /** * Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. + * + * @var int|null */ private $thumbnailWidth; /** * Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. + * + * @var int|null */ private $tileHeight; /** * Number of thumbnails in each row of a tile image. Set a value between 1 and 512. + * + * @var int|null */ private $tileWidth; diff --git a/src/Service/MediaConvert/src/ValueObject/CmfcSettings.php b/src/Service/MediaConvert/src/ValueObject/CmfcSettings.php index e5066d16b..ab005b717 100644 --- a/src/Service/MediaConvert/src/ValueObject/CmfcSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/CmfcSettings.php @@ -29,6 +29,8 @@ final class CmfcSettings * applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, * MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies * between audio and video duration will depend on your output audio codec. + * + * @var CmfcAudioDuration::*|null */ private $audioDuration; @@ -39,6 +41,8 @@ final class CmfcSettings * like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that * this audio track belongs to with a video rendition, include the same value that you provide here for that video * output's setting Audio rendition sets (audioRenditionSets). + * + * @var string|null */ private $audioGroupId; @@ -54,6 +58,8 @@ final class CmfcSettings * for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value * will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 * #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8. + * + * @var string|null */ private $audioRenditionSets; @@ -69,6 +75,8 @@ final class CmfcSettings * to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to * Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly * choose a value for this setting. + * + * @var CmfcAudioTrackType::*|null */ private $audioTrackType; @@ -78,6 +86,8 @@ final class CmfcSettings * EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this * parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple * documentation. + * + * @var CmfcDescriptiveVideoServiceFlag::*|null */ private $descriptiveVideoServiceFlag; @@ -87,6 +97,8 @@ final class CmfcSettings * that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular * child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value * Exclude (EXCLUDE). + * + * @var CmfcIFrameOnlyManifest::*|null */ private $iframeOnlyManifest; @@ -94,6 +106,8 @@ final class CmfcSettings * To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads * KLV metadata present in your input and writes each instance to a separate event message box in the output, according * to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank. + * + * @var CmfcKlvMetadata::*|null */ private $klvMetadata; @@ -104,6 +118,8 @@ final class CmfcSettings * "urn:scte:scte35:2013:bin". To leave these elements out of your output MPD manifest, set Manifest metadata signaling * to Disabled. To enable Manifest metadata signaling, you must also set SCTE-35 source to Passthrough, ESAM SCTE-35 to * insert, or ID3 metadata (TimedMetadata) to Passthrough. + * + * @var CmfcManifestMetadataSignaling::*|null */ private $manifestMetadataSignaling; @@ -111,6 +127,8 @@ final class CmfcSettings * Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output * at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML * (sccXml). + * + * @var CmfcScte35Esam::*|null */ private $scte35Esam; @@ -118,6 +136,8 @@ final class CmfcSettings * Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you * want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want * those SCTE-35 markers in this output. + * + * @var CmfcScte35Source::*|null */ private $scte35Source; @@ -126,6 +146,8 @@ final class CmfcSettings * ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 * metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or * leave blank. + * + * @var CmfcTimedMetadata::*|null */ private $timedMetadata; @@ -134,6 +156,8 @@ final class CmfcSettings * For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. * Leave blank to use the default value Version 0. * When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Passthrough. + * + * @var CmfcTimedMetadataBoxVersion::*|null */ private $timedMetadataBoxVersion; @@ -142,6 +166,8 @@ final class CmfcSettings * information, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. Leave blank to use the default value: * https://aomedia.org/emsg/ID3 When you specify a value for ID3 metadata scheme ID URI, you must also set ID3 metadata * (timedMetadata) to Passthrough. + * + * @var string|null */ private $timedMetadataSchemeIdUri; @@ -149,6 +175,8 @@ final class CmfcSettings * Specify the event message box (eMSG) value for ID3 timed metadata in your output. For more information, see ISO/IEC * 23009-1:2022 section 5.10.3.3.4 Semantics. When you specify a value for ID3 Metadata Value, you must also set ID3 * metadata (timedMetadata) to Passthrough. + * + * @var string|null */ private $timedMetadataValue; diff --git a/src/Service/MediaConvert/src/ValueObject/ColorCorrector.php b/src/Service/MediaConvert/src/ValueObject/ColorCorrector.php index 4bcfd13a8..46d92965d 100644 --- a/src/Service/MediaConvert/src/ValueObject/ColorCorrector.php +++ b/src/Service/MediaConvert/src/ValueObject/ColorCorrector.php @@ -14,11 +14,15 @@ final class ColorCorrector { /** * Brightness level. + * + * @var int|null */ private $brightness; /** * Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip. + * + * @var ClipLimits|null */ private $clipLimits; @@ -34,11 +38,15 @@ final class ColorCorrector * * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * * P3D65 (SDR): Display P3, sRGB, BT.709 * * P3D65 (HDR): Display P3, PQ, BT.709. + * + * @var ColorSpaceConversion::*|null */ private $colorSpaceConversion; /** * Contrast level. + * + * @var int|null */ private $contrast; @@ -51,6 +59,8 @@ final class ColorCorrector * (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default * value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more * information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. + * + * @var Hdr10Metadata|null */ private $hdr10Metadata; @@ -63,11 +73,15 @@ final class ColorCorrector * this mode when any of your source content is HDR10, and for the best results when it is mastered for 1000 nits. You * may notice loss of details in bright or saturated areas of your output. HDR to SDR tone mapping has no effect when * your input is SDR. + * + * @var HDRToSDRToneMapper::*|null */ private $hdrToSdrToneMapper; /** * Hue in degrees. + * + * @var int|null */ private $hue; @@ -82,11 +96,15 @@ final class ColorCorrector * MediaConvert also corrects any YUV values that, when converted to RGB, would be outside the bounds you specify under * Minimum RGB tolerance and Maximum RGB tolerance. With either limited range conversion, MediaConvert writes the sample * range metadata in the output. + * + * @var SampleRangeConversion::*|null */ private $sampleRangeConversion; /** * Saturation level. + * + * @var int|null */ private $saturation; @@ -97,6 +115,8 @@ final class ColorCorrector * metadata, manually specify a color space in the input video selector. For 1,000 nit peak brightness displays, we * recommend that you set SDR reference white level to 203 (according to ITU-R BT.2408). Leave blank to use the default * value of 100, or specify an integer from 100 to 1000. + * + * @var int|null */ private $sdrReferenceWhiteLevel; diff --git a/src/Service/MediaConvert/src/ValueObject/ContainerSettings.php b/src/Service/MediaConvert/src/ValueObject/ContainerSettings.php index bba20e579..0302c6608 100644 --- a/src/Service/MediaConvert/src/ValueObject/ContainerSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/ContainerSettings.php @@ -12,17 +12,23 @@ final class ContainerSettings { /** * These settings relate to the fragmented MP4 container for the segments in your CMAF outputs. + * + * @var CmfcSettings|null */ private $cmfcSettings; /** * Container for this output. Some containers require a container settings object. If not specified, the default object * will be created. + * + * @var ContainerType::*|null */ private $container; /** * Settings for F4v container. + * + * @var F4vSettings|null */ private $f4vSettings; @@ -34,17 +40,23 @@ final class ContainerSettings * MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and * players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to * locate specific data within the asset. + * + * @var M2tsSettings|null */ private $m2tsSettings; /** * These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS * outputs. + * + * @var M3u8Settings|null */ private $m3u8Settings; /** * These settings relate to your QuickTime MOV output container. + * + * @var MovSettings|null */ private $movSettings; @@ -52,16 +64,22 @@ final class ContainerSettings * These settings relate to your MP4 output container. You can create audio only outputs with this container. For more * information, see * https://docs.aws.amazon.com/mediaconvert/latest/ug/supported-codecs-containers-audio-only.html#output-codecs-and-containers-supported-for-audio-only. + * + * @var Mp4Settings|null */ private $mp4Settings; /** * These settings relate to the fragmented MP4 container for the segments in your DASH outputs. + * + * @var MpdSettings|null */ private $mpdSettings; /** * These settings relate to your MXF output container. + * + * @var MxfSettings|null */ private $mxfSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/DashAdditionalManifest.php b/src/Service/MediaConvert/src/ValueObject/DashAdditionalManifest.php index 883b2c871..dbf56d9a0 100644 --- a/src/Service/MediaConvert/src/ValueObject/DashAdditionalManifest.php +++ b/src/Service/MediaConvert/src/ValueObject/DashAdditionalManifest.php @@ -13,11 +13,15 @@ final class DashAdditionalManifest * of the other main manifests in the output group. For example, say that the default main manifest for your DASH group * is film-name.mpd. If you enter "-no-premium" for this setting, then the file name the service generates for this * top-level manifest is film-name-no-premium.mpd. + * + * @var string|null */ private $manifestNameModifier; /** * Specify the outputs that you want this additional top-level manifest to reference. + * + * @var string[]|null */ private $selectedOutputs; diff --git a/src/Service/MediaConvert/src/ValueObject/DashIsoEncryptionSettings.php b/src/Service/MediaConvert/src/ValueObject/DashIsoEncryptionSettings.php index 4d64907ff..d4e48639c 100644 --- a/src/Service/MediaConvert/src/ValueObject/DashIsoEncryptionSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DashIsoEncryptionSettings.php @@ -15,12 +15,16 @@ final class DashIsoEncryptionSettings * DASH H.264 outputs with DRM encryption. Choose Unencrypted SEI (UNENCRYPTED_SEI) only to correct problems with * playback on older devices. Otherwise, keep the default setting CENC v1 (CENC_V1). If you choose Unencrypted SEI, for * that output, the service will exclude the access unit delimiter and will leave the SEI NAL units unencrypted. + * + * @var DashIsoPlaybackDeviceCompatibility::*|null */ private $playbackDeviceCompatibility; /** * If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a * SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead. + * + * @var SpekeKeyProvider|null */ private $spekeKeyProvider; diff --git a/src/Service/MediaConvert/src/ValueObject/DashIsoGroupSettings.php b/src/Service/MediaConvert/src/ValueObject/DashIsoGroupSettings.php index 541018dcb..d8d444dea 100644 --- a/src/Service/MediaConvert/src/ValueObject/DashIsoGroupSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DashIsoGroupSettings.php @@ -27,6 +27,8 @@ final class DashIsoGroupSettings * By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default * manifest references every output in the output group. To create additional DASH manifests that reference a subset of * the outputs in the output group, specify a list of them here. + * + * @var DashAdditionalManifest[]|null */ private $additionalManifests; @@ -38,12 +40,16 @@ final class DashIsoGroupSettings * (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby * channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write this instead: * tag:dolby.com,2014:dash:audio_channel_configuration:2011. + * + * @var DashIsoGroupAudioChannelConfigSchemeIdUri::*|null */ private $audioChannelConfigSchemeIdUri; /** * A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if * streams are delivered from a different URL than the manifest file. + * + * @var string|null */ private $baseUrl; @@ -53,6 +59,8 @@ final class DashIsoGroupSettings * Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any Representation that does not share a * common timeline. To write a video AdaptationSet for each different output framerate, and a common SegmentTimeline in * each AdaptationSet: Choose Distinct. + * + * @var DashManifestStyle::*|null */ private $dashManifestStyle; @@ -60,16 +68,22 @@ final class DashIsoGroupSettings * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts * format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the * input file. If your job has multiple inputs, the service uses the filename of the first input file. + * + * @var string|null */ private $destination; /** * Settings associated with the destination. Will vary based on the type of destination. + * + * @var DestinationSettings|null */ private $destinationSettings; /** * DRM settings. + * + * @var DashIsoEncryptionSettings|null */ private $encryption; @@ -78,11 +92,15 @@ final class DashIsoGroupSettings * that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. * When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the * creation of many output files as in other output types. + * + * @var int|null */ private $fragmentLength; /** * Supports HbbTV specification as indicated. + * + * @var DashIsoHbbtvCompliance::*|null */ private $hbbtvCompliance; @@ -93,16 +111,22 @@ final class DashIsoGroupSettings * an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku * trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this * Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md. + * + * @var DashIsoImageBasedTrickPlay::*|null */ private $imageBasedTrickPlay; /** * Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED. + * + * @var DashIsoImageBasedTrickPlaySettings|null */ private $imageBasedTrickPlaySettings; /** * Minimum time of initially buffered media that is needed to ensure smooth playout. + * + * @var int|null */ private $minBufferTime; @@ -114,6 +138,8 @@ final class DashIsoGroupSettings * this setting, the encoder will combine any final segment that is shorter than the length that you specify with the * previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a * minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds. + * + * @var float|null */ private $minFinalSegmentLength; @@ -122,6 +148,8 @@ final class DashIsoGroupSettings * recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. * Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the * calculated average bitrate of the encoded video output, in bits per second. + * + * @var DashIsoMpdManifestBandwidthType::*|null */ private $mpdManifestBandwidthType; @@ -130,6 +158,8 @@ final class DashIsoGroupSettings * signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand * (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose * On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE). + * + * @var DashIsoMpdProfile::*|null */ private $mpdProfile; @@ -140,12 +170,16 @@ final class DashIsoGroupSettings * initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the * initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that * don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here. + * + * @var DashIsoPtsOffsetHandlingForBFrames::*|null */ private $ptsOffsetHandlingForBframes; /** * When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length * and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created. + * + * @var DashIsoSegmentControl::*|null */ private $segmentControl; @@ -154,6 +188,8 @@ final class DashIsoGroupSettings * Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this * value strictly. Use Segment control (DashIsoSegmentControl) to specify whether MediaConvert creates separate segment * files or one content file that has metadata to mark the segment boundaries. + * + * @var int|null */ private $segmentLength; @@ -162,6 +198,8 @@ final class DashIsoGroupSettings * exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. * Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP * boundary. + * + * @var DashIsoSegmentLengthControl::*|null */ private $segmentLengthControl; @@ -171,6 +209,8 @@ final class DashIsoGroupSettings * and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, * set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition * time offsets will increment using signed integers. + * + * @var DashIsoVideoCompositionOffsets::*|null */ private $videoCompositionOffsets; @@ -180,6 +220,8 @@ final class DashIsoGroupSettings * manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the * Representation level. When you don't enable this setting, the service writes approximate segment durations in your * DASH manifest. + * + * @var DashIsoWriteSegmentTimelineInRepresentation::*|null */ private $writeSegmentTimelineInRepresentation; diff --git a/src/Service/MediaConvert/src/ValueObject/DashIsoImageBasedTrickPlaySettings.php b/src/Service/MediaConvert/src/ValueObject/DashIsoImageBasedTrickPlaySettings.php index 720ca494d..590d3e6fd 100644 --- a/src/Service/MediaConvert/src/ValueObject/DashIsoImageBasedTrickPlaySettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DashIsoImageBasedTrickPlaySettings.php @@ -14,6 +14,8 @@ final class DashIsoImageBasedTrickPlaySettings * The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates * thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert * generates thumbnails according to the interval you specify in thumbnailInterval. + * + * @var DashIsoIntervalCadence::*|null */ private $intervalCadence; @@ -21,6 +23,8 @@ final class DashIsoImageBasedTrickPlaySettings * Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail * width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be * rejected. Must be divisible by 2. + * + * @var int|null */ private $thumbnailHeight; @@ -29,21 +33,29 @@ final class DashIsoImageBasedTrickPlaySettings * align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. * For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame * interval to generate thumbnails. + * + * @var float|null */ private $thumbnailInterval; /** * Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. + * + * @var int|null */ private $thumbnailWidth; /** * Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. + * + * @var int|null */ private $tileHeight; /** * Number of thumbnails in each row of a tile image. Set a value between 1 and 512. + * + * @var int|null */ private $tileWidth; diff --git a/src/Service/MediaConvert/src/ValueObject/Deinterlacer.php b/src/Service/MediaConvert/src/ValueObject/Deinterlacer.php index 8bfd58540..8e657b381 100644 --- a/src/Service/MediaConvert/src/ValueObject/Deinterlacer.php +++ b/src/Service/MediaConvert/src/ValueObject/Deinterlacer.php @@ -17,6 +17,8 @@ final class Deinterlacer * blend produces smoother motion. If your source file includes a ticker, such as a scrolling headline at the bottom of * the frame: Choose Interpolate ticker or Blend ticker. To apply field doubling: Choose Linear interpolation. Note that * Linear interpolation may introduce video artifacts into your output. + * + * @var DeinterlaceAlgorithm::*|null */ private $algorithm; @@ -27,6 +29,8 @@ final class Deinterlacer * there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn * on otherwise; processing frames that are already progressive into progressive will probably result in lower quality * video. + * + * @var DeinterlacerControl::*|null */ private $control; @@ -34,6 +38,8 @@ final class Deinterlacer * Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - * Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive * 23.976p. - Adaptive auto-detects and converts to progressive. + * + * @var DeinterlacerMode::*|null */ private $mode; diff --git a/src/Service/MediaConvert/src/ValueObject/DestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/DestinationSettings.php index 974eb1b7d..4699db236 100644 --- a/src/Service/MediaConvert/src/ValueObject/DestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DestinationSettings.php @@ -9,6 +9,8 @@ final class DestinationSettings { /** * Settings associated with S3 destination. + * + * @var S3DestinationSettings|null */ private $s3Settings; diff --git a/src/Service/MediaConvert/src/ValueObject/DolbyVision.php b/src/Service/MediaConvert/src/ValueObject/DolbyVision.php index 8d4e887e0..ffdc34562 100644 --- a/src/Service/MediaConvert/src/ValueObject/DolbyVision.php +++ b/src/Service/MediaConvert/src/ValueObject/DolbyVision.php @@ -15,11 +15,15 @@ final class DolbyVision /** * Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your * input with new values. + * + * @var DolbyVisionLevel6Metadata|null */ private $l6Metadata; /** * Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies. + * + * @var DolbyVisionLevel6Mode::*|null */ private $l6Mode; @@ -30,6 +34,8 @@ final class DolbyVision * HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 * sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent * might not be guaranteed with extreme 1,000 nits trims. + * + * @var DolbyVisionMapping::*|null */ private $mapping; @@ -38,6 +44,8 @@ final class DolbyVision * output. Your input must include Dolby Vision metadata or an HDR10 YUV color space. Use Profile 8.1 to include * frame-interleaved Dolby Vision metadata and HDR10 metadata in your output. Your input must include Dolby Vision * metadata. + * + * @var DolbyVisionProfile::*|null */ private $profile; diff --git a/src/Service/MediaConvert/src/ValueObject/DolbyVisionLevel6Metadata.php b/src/Service/MediaConvert/src/ValueObject/DolbyVisionLevel6Metadata.php index be9368d2d..d655d3ca6 100644 --- a/src/Service/MediaConvert/src/ValueObject/DolbyVisionLevel6Metadata.php +++ b/src/Service/MediaConvert/src/ValueObject/DolbyVisionLevel6Metadata.php @@ -11,12 +11,16 @@ final class DolbyVisionLevel6Metadata /** * Maximum Content Light Level. Static HDR metadata that corresponds to the brightest pixel in the entire stream. * Measured in nits. + * + * @var int|null */ private $maxCll; /** * Maximum Frame-Average Light Level. Static HDR metadata that corresponds to the highest frame-average brightness in * the entire stream. Measured in nits. + * + * @var int|null */ private $maxFall; diff --git a/src/Service/MediaConvert/src/ValueObject/DvbNitSettings.php b/src/Service/MediaConvert/src/ValueObject/DvbNitSettings.php index 95edddab3..ea2772749 100644 --- a/src/Service/MediaConvert/src/ValueObject/DvbNitSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DvbNitSettings.php @@ -11,17 +11,23 @@ final class DvbNitSettings { /** * The numeric value placed in the Network Information Table (NIT). + * + * @var int|null */ private $networkId; /** * The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length is * 256 characters. + * + * @var string|null */ private $networkName; /** * The number of milliseconds between instances of this table in the output transport stream. + * + * @var int|null */ private $nitInterval; diff --git a/src/Service/MediaConvert/src/ValueObject/DvbSdtSettings.php b/src/Service/MediaConvert/src/ValueObject/DvbSdtSettings.php index b50ba2e59..f6d1ab346 100644 --- a/src/Service/MediaConvert/src/ValueObject/DvbSdtSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DvbSdtSettings.php @@ -17,22 +17,30 @@ final class DvbSdtSettings * stream to output stream. "Follow input SDT if present" copies SDT information from input stream to output stream if * SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter "SDT Manually" * means user will enter the SDT information. "No SDT" means output stream will not contain SDT information. + * + * @var OutputSdt::*|null */ private $outputSdt; /** * The number of milliseconds between instances of this table in the output transport stream. + * + * @var int|null */ private $sdtInterval; /** * The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters. + * + * @var string|null */ private $serviceName; /** * The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 * characters. + * + * @var string|null */ private $serviceProviderName; diff --git a/src/Service/MediaConvert/src/ValueObject/DvbSubDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/DvbSubDestinationSettings.php index ec36fcd2d..02770e10f 100644 --- a/src/Service/MediaConvert/src/ValueObject/DvbSubDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DvbSubDestinationSettings.php @@ -29,6 +29,8 @@ final class DvbSubDestinationSettings * bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will * be justified (either left or centered) relative to those coordinates. Within your job settings, all of your DVB-Sub * settings must be identical. + * + * @var DvbSubtitleAlignment::*|null */ private $alignment; @@ -39,12 +41,16 @@ final class DvbSubDestinationSettings * in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white * text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies * to all of your output captions text. + * + * @var DvbSubtitleApplyFontColor::*|null */ private $applyFontColor; /** * Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style * passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present. + * + * @var DvbSubtitleBackgroundColor::*|null */ private $backgroundColor; @@ -54,6 +60,8 @@ final class DvbSubDestinationSettings * information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to * use a value of 0 and remove all backgrounds from your output captions. Within your job settings, all of your DVB-Sub * settings must be identical. + * + * @var int|null */ private $backgroundOpacity; @@ -65,6 +73,8 @@ final class DvbSubDestinationSettings * x-coordinate and DDS y-coordinate. For video resolutions with a height of 576 pixels or less, MediaConvert doesn't * include the DDS, regardless of the value you choose for DDS handling. All burn-in and DVB-Sub font settings must * match. + * + * @var DvbddsHandling::*|null */ private $ddsHandling; @@ -75,6 +85,8 @@ final class DvbSubDestinationSettings * choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value * other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or * to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match. + * + * @var int|null */ private $ddsXcoordinate; @@ -85,6 +97,8 @@ final class DvbSubDestinationSettings * this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other * than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to * the page composition segment (PCS). All burn-in and DVB-Sub font settings must match. + * + * @var int|null */ private $ddsYcoordinate; @@ -95,6 +109,8 @@ final class DvbSubDestinationSettings * there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font * that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all * unsupported fonts from your input. + * + * @var DvbSubSubtitleFallbackFont::*|null */ private $fallbackFont; @@ -102,18 +118,24 @@ final class DvbSubDestinationSettings * Specify the color of the captions text. Leave Font color (FontColor) blank and set Style passthrough * (StylePassthrough) to enabled to use the font color data from your input captions, if present. Within your job * settings, all of your DVB-Sub settings must be identical. + * + * @var DvbSubtitleFontColor::*|null */ private $fontColor; /** * Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent. * Within your job settings, all of your DVB-Sub settings must be identical. + * + * @var int|null */ private $fontOpacity; /** * Specify the Font resolution (FontResolution) in DPI (dots per inch). * Within your job settings, all of your DVB-Sub settings must be identical. + * + * @var int|null */ private $fontResolution; @@ -122,12 +144,16 @@ final class DvbSubDestinationSettings * font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your * input font script uses Simplified or Traditional Chinese. Within your job settings, all of your DVB-Sub settings must * be identical. + * + * @var FontScript::*|null */ private $fontScript; /** * Specify the Font size (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font * size. Within your job settings, all of your DVB-Sub settings must be identical. + * + * @var int|null */ private $fontSize; @@ -135,6 +161,8 @@ final class DvbSubDestinationSettings * Specify the height, in pixels, of this set of DVB-Sub captions. The default value is 576 pixels. Related setting: * When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and * DVB-Sub font settings must match. + * + * @var int|null */ private $height; @@ -142,6 +170,8 @@ final class DvbSubDestinationSettings * Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing * red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of * 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB. + * + * @var string|null */ private $hexFontColor; @@ -149,6 +179,8 @@ final class DvbSubDestinationSettings * Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to * enabled to use the font outline color data from your input captions, if present. Within your job settings, all of * your DVB-Sub settings must be identical. + * + * @var DvbSubtitleOutlineColor::*|null */ private $outlineColor; @@ -156,6 +188,8 @@ final class DvbSubDestinationSettings * Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style * passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present. Within * your job settings, all of your DVB-Sub settings must be identical. + * + * @var int|null */ private $outlineSize; @@ -163,6 +197,8 @@ final class DvbSubDestinationSettings * Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style * passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present. Within * your job settings, all of your DVB-Sub settings must be identical. + * + * @var DvbSubtitleShadowColor::*|null */ private $shadowColor; @@ -172,12 +208,16 @@ final class DvbSubDestinationSettings * shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, * leave blank to use a value of 0 and remove all shadows from your output captions. Within your job settings, all of * your DVB-Sub settings must be identical. + * + * @var int|null */ private $shadowOpacity; /** * Specify the horizontal offset of the shadow, relative to the captions in pixels. A value of -2 would result in a * shadow offset 2 pixels to the left. Within your job settings, all of your DVB-Sub settings must be identical. + * + * @var int|null */ private $shadowXoffset; @@ -186,6 +226,8 @@ final class DvbSubDestinationSettings * offset 2 pixels above the text. Leave Shadow y-offset (ShadowYOffset) blank and set Style passthrough * (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present. Within your job * settings, all of your DVB-Sub settings must be identical. + * + * @var int|null */ private $shadowYoffset; @@ -196,12 +238,16 @@ final class DvbSubDestinationSettings * input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic * sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the * individual style and position settings. + * + * @var DvbSubtitleStylePassthrough::*|null */ private $stylePassthrough; /** * Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles * include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue. + * + * @var DvbSubtitlingType::*|null */ private $subtitlingType; @@ -210,6 +256,8 @@ final class DvbSubDestinationSettings * on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more * accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job * settings, all of your DVB-Sub settings must be identical. + * + * @var DvbSubtitleTeletextSpacing::*|null */ private $teletextSpacing; @@ -217,6 +265,8 @@ final class DvbSubDestinationSettings * Specify the width, in pixels, of this set of DVB-Sub captions. The default value is 720 pixels. Related setting: When * you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and * DVB-Sub font settings must match. + * + * @var int|null */ private $width; @@ -225,6 +275,8 @@ final class DvbSubDestinationSettings * value of 10 would result in the captions starting 10 pixels from the left ofthe output. If no explicit x_position is * provided, the horizontal caption position will bedetermined by the alignment parameter. Within your job settings, all * of your DVB-Sub settings must be identical. + * + * @var int|null */ private $xposition; @@ -233,6 +285,8 @@ final class DvbSubDestinationSettings * would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, * the caption will be positioned towards the bottom of the output. Within your job settings, all of your DVB-Sub * settings must be identical. + * + * @var int|null */ private $yposition; diff --git a/src/Service/MediaConvert/src/ValueObject/DvbSubSourceSettings.php b/src/Service/MediaConvert/src/ValueObject/DvbSubSourceSettings.php index 9f082d7a4..60971f7a1 100644 --- a/src/Service/MediaConvert/src/ValueObject/DvbSubSourceSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DvbSubSourceSettings.php @@ -10,6 +10,8 @@ final class DvbSubSourceSettings /** * When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All * DVB-Sub content is passed through, regardless of selectors. + * + * @var int|null */ private $pid; diff --git a/src/Service/MediaConvert/src/ValueObject/DvbTdtSettings.php b/src/Service/MediaConvert/src/ValueObject/DvbTdtSettings.php index cc4fdbcb7..8a4e288b3 100644 --- a/src/Service/MediaConvert/src/ValueObject/DvbTdtSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/DvbTdtSettings.php @@ -11,6 +11,8 @@ final class DvbTdtSettings { /** * The number of milliseconds between instances of this table in the output transport stream. + * + * @var int|null */ private $tdtInterval; diff --git a/src/Service/MediaConvert/src/ValueObject/Eac3AtmosSettings.php b/src/Service/MediaConvert/src/ValueObject/Eac3AtmosSettings.php index 17ab31429..263d8129c 100644 --- a/src/Service/MediaConvert/src/ValueObject/Eac3AtmosSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/Eac3AtmosSettings.php @@ -23,22 +23,30 @@ final class Eac3AtmosSettings * Specify the average bitrate for this output in bits per second. Valid values: 384k, 448k, 576k, 640k, 768k, 1024k * Default value: 448k Note that MediaConvert supports 384k only with channel-based immersive (CBI) 7.1.4 and 5.1.4 * inputs. For CBI 9.1.6 and other input types, MediaConvert automatically increases your output bitrate to 448k. + * + * @var int|null */ private $bitrate; /** * Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 * bitstream mode, see ATSC A/52-2012 (Annex E). + * + * @var Eac3AtmosBitstreamMode::*|null */ private $bitstreamMode; /** * The coding mode for Dolby Digital Plus JOC (Atmos). + * + * @var Eac3AtmosCodingMode::*|null */ private $codingMode; /** * Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis. + * + * @var Eac3AtmosDialogueIntelligence::*|null */ private $dialogueIntelligence; @@ -50,6 +58,8 @@ final class Eac3AtmosSettings * center (LtRtCenterMixLevel), Left only/Right only center (LoRoCenterMixLevel), and Stereo downmix (StereoDownmix). * When you keep Custom (SPECIFIED) for Downmix control (DownmixControl) and you don't specify values for the related * settings, MediaConvert uses default values for those settings. + * + * @var Eac3AtmosDownmixControl::*|null */ private $downmixControl; @@ -61,6 +71,8 @@ final class Eac3AtmosSettings * (DynamicRangeCompressionLine). For information about the Dolby DRC operating modes and profiles, see the Dynamic * Range Control chapter of the Dolby Metadata Guide at * https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. + * + * @var Eac3AtmosDynamicRangeCompressionLine::*|null */ private $dynamicRangeCompressionLine; @@ -72,6 +84,8 @@ final class Eac3AtmosSettings * (DynamicRangeCompressionRf). For information about the Dolby DRC operating modes and profiles, see the Dynamic Range * Control chapter of the Dolby Metadata Guide at * https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. + * + * @var Eac3AtmosDynamicRangeCompressionRf::*|null */ private $dynamicRangeCompressionRf; @@ -83,6 +97,8 @@ final class Eac3AtmosSettings * compression RF (DynamicRangeCompressionRf). When you keep the value Custom (SPECIFIED) for Dynamic range control * (DynamicRangeControl) and you don't specify values for the related settings, MediaConvert uses default values for * those settings. + * + * @var Eac3AtmosDynamicRangeControl::*|null */ private $dynamicRangeControl; @@ -93,6 +109,8 @@ final class Eac3AtmosSettings * choose for Stereo downmix (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the * default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores * Left only/Right only center (LoRoCenterMixLevel). + * + * @var float|null */ private $loRoCenterMixLevel; @@ -103,6 +121,8 @@ final class Eac3AtmosSettings * that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, * keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert * ignores Left only/Right only surround (LoRoSurroundMixLevel). + * + * @var float|null */ private $loRoSurroundMixLevel; @@ -113,6 +133,8 @@ final class Eac3AtmosSettings * choose for Stereo downmix (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the * default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores * Left total/Right total center (LtRtCenterMixLevel). + * + * @var float|null */ private $ltRtCenterMixLevel; @@ -123,22 +145,30 @@ final class Eac3AtmosSettings * depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Related setting: To have * MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control * (DownmixControl). Otherwise, the service ignores Left total/Right total surround (LtRtSurroundMixLevel). + * + * @var float|null */ private $ltRtSurroundMixLevel; /** * Choose how the service meters the loudness of your audio. + * + * @var Eac3AtmosMeteringMode::*|null */ private $meteringMode; /** * This value is always 48000. It represents the sample rate in Hz. + * + * @var int|null */ private $sampleRate; /** * Specify the percentage of audio content, from 0% to 100%, that must be speech in order for the encoder to use the * measured speech loudness as the overall program loudness. Default value: 15%. + * + * @var int|null */ private $speechThreshold; @@ -146,12 +176,16 @@ final class Eac3AtmosSettings * Choose how the service does stereo downmixing. Default value: Not indicated (ATMOS_STORAGE_DDP_DMIXMOD_NOT_INDICATED) * Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting * Downmix control (DownmixControl). Otherwise, MediaConvert ignores Stereo downmix (StereoDownmix). + * + * @var Eac3AtmosStereoDownmix::*|null */ private $stereoDownmix; /** * Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and * right surround channels. + * + * @var Eac3AtmosSurroundExMode::*|null */ private $surroundExMode; diff --git a/src/Service/MediaConvert/src/ValueObject/Eac3Settings.php b/src/Service/MediaConvert/src/ValueObject/Eac3Settings.php index e2a1fd7dd..807caca94 100644 --- a/src/Service/MediaConvert/src/ValueObject/Eac3Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Eac3Settings.php @@ -25,6 +25,8 @@ final class Eac3Settings { /** * If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. + * + * @var Eac3AttenuationControl::*|null */ private $attenuationControl; @@ -34,27 +36,37 @@ final class Eac3Settings * ETSI TS 102 366. Valid bitrates for coding mode 1/0: Default: 96000. Minimum: 32000. Maximum: 3024000. Valid bitrates * for coding mode 2/0: Default: 192000. Minimum: 96000. Maximum: 3024000. Valid bitrates for coding mode 3/2: Default: * 384000. Minimum: 192000. Maximum: 3024000. + * + * @var int|null */ private $bitrate; /** * Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 * bitstream mode, see ATSC A/52-2012 (Annex E). + * + * @var Eac3BitstreamMode::*|null */ private $bitstreamMode; /** * Dolby Digital Plus coding mode. Determines number of channels. + * + * @var Eac3CodingMode::*|null */ private $codingMode; /** * Activates a DC highpass filter for all input channels. + * + * @var Eac3DcFilter::*|null */ private $dcFilter; /** * Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. + * + * @var int|null */ private $dialnorm; @@ -64,6 +76,8 @@ final class Eac3Settings * any value you provide for Dynamic range compression profile (DynamicRangeCompressionProfile). For information about * the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide * at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. + * + * @var Eac3DynamicRangeCompressionLine::*|null */ private $dynamicRangeCompressionLine; @@ -73,16 +87,22 @@ final class Eac3Settings * value you provide for Dynamic range compression profile (DynamicRangeCompressionProfile). For information about the * Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at * https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. + * + * @var Eac3DynamicRangeCompressionRf::*|null */ private $dynamicRangeCompressionRf; /** * When encoding 3/2 audio, controls whether the LFE channel is enabled. + * + * @var Eac3LfeControl::*|null */ private $lfeControl; /** * Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode. + * + * @var Eac3LfeFilter::*|null */ private $lfeFilter; @@ -93,6 +113,8 @@ final class Eac3Settings * the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for * the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left * only/Right only center (loRoCenterMixLevel). + * + * @var float|null */ private $loRoCenterMixLevel; @@ -103,6 +125,8 @@ final class Eac3Settings * setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding * mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only * surround (loRoSurroundMixLevel). + * + * @var float|null */ private $loRoSurroundMixLevel; @@ -113,6 +137,8 @@ final class Eac3Settings * the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for * the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left * total/Right total center (ltRtCenterMixLevel). + * + * @var float|null */ private $ltRtCenterMixLevel; @@ -123,12 +149,16 @@ final class Eac3Settings * This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting * Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right * total surround (ltRtSurroundMixLevel). + * + * @var float|null */ private $ltRtSurroundMixLevel; /** * When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this * audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. + * + * @var Eac3MetadataControl::*|null */ private $metadataControl; @@ -136,16 +166,22 @@ final class Eac3Settings * When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is * dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent * DD+ output as the system alternates between passthrough and encoding. + * + * @var Eac3PassthroughControl::*|null */ private $passthroughControl; /** * Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode. + * + * @var Eac3PhaseControl::*|null */ private $phaseControl; /** * This value is always 48000. It represents the sample rate in Hz. + * + * @var int|null */ private $sampleRate; @@ -153,17 +189,23 @@ final class Eac3Settings * Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, * C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding * mode, the service ignores Stereo downmix (Eac3StereoDownmix). + * + * @var Eac3StereoDownmix::*|null */ private $stereoDownmix; /** * When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right * surround channels. + * + * @var Eac3SurroundExMode::*|null */ private $surroundExMode; /** * When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. + * + * @var Eac3SurroundMode::*|null */ private $surroundMode; diff --git a/src/Service/MediaConvert/src/ValueObject/EmbeddedDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/EmbeddedDestinationSettings.php index 0fdda47f0..8b5f39651 100644 --- a/src/Service/MediaConvert/src/ValueObject/EmbeddedDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/EmbeddedDestinationSettings.php @@ -16,6 +16,8 @@ final class EmbeddedDestinationSettings * stream. Specify a CC number for each captions channel in this output. If you have two channels, choose CC numbers * that aren't in the same field. For example, choose 1 and 3. For more information, see * https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. + * + * @var int|null */ private $destination608ChannelNumber; @@ -26,6 +28,8 @@ final class EmbeddedDestinationSettings * in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, * MediaConvert uses the number that you specify for CC channel number (destination608ChannelNumber) for the 708 service * number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. + * + * @var int|null */ private $destination708ServiceNumber; diff --git a/src/Service/MediaConvert/src/ValueObject/EmbeddedSourceSettings.php b/src/Service/MediaConvert/src/ValueObject/EmbeddedSourceSettings.php index a092f8bd9..9e3ded81d 100644 --- a/src/Service/MediaConvert/src/ValueObject/EmbeddedSourceSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/EmbeddedSourceSettings.php @@ -15,23 +15,31 @@ final class EmbeddedSourceSettings * Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose * Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the * 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708. + * + * @var EmbeddedConvert608To708::*|null */ private $convert608To708; /** * Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. + * + * @var int|null */ private $source608ChannelNumber; /** * Specifies the video track index used for extracting captions. The system only supports one input video track, so this * should always be set to '1'. + * + * @var int|null */ private $source608TrackNumber; /** * By default, the service terminates any unterminated captions at the end of each input. If you want the caption to * continue onto your next input, disable this setting. + * + * @var EmbeddedTerminateCaptions::*|null */ private $terminateCaptions; diff --git a/src/Service/MediaConvert/src/ValueObject/Endpoint.php b/src/Service/MediaConvert/src/ValueObject/Endpoint.php index f68bd40c3..1e866ec17 100644 --- a/src/Service/MediaConvert/src/ValueObject/Endpoint.php +++ b/src/Service/MediaConvert/src/ValueObject/Endpoint.php @@ -9,6 +9,8 @@ final class Endpoint { /** * URL of endpoint. + * + * @var string|null */ private $url; diff --git a/src/Service/MediaConvert/src/ValueObject/EsamManifestConfirmConditionNotification.php b/src/Service/MediaConvert/src/ValueObject/EsamManifestConfirmConditionNotification.php index aaf713c0c..8cbe93030 100644 --- a/src/Service/MediaConvert/src/ValueObject/EsamManifestConfirmConditionNotification.php +++ b/src/Service/MediaConvert/src/ValueObject/EsamManifestConfirmConditionNotification.php @@ -11,6 +11,8 @@ final class EsamManifestConfirmConditionNotification * Provide your ESAM ManifestConfirmConditionNotification XML document inside your JSON job settings. Form the XML * document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the Manifest Conditioning instructions in the * message that you supply. + * + * @var string|null */ private $mccXml; diff --git a/src/Service/MediaConvert/src/ValueObject/EsamSettings.php b/src/Service/MediaConvert/src/ValueObject/EsamSettings.php index f82ee4654..63cc3e35d 100644 --- a/src/Service/MediaConvert/src/ValueObject/EsamSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/EsamSettings.php @@ -10,6 +10,8 @@ final class EsamSettings /** * Specifies an ESAM ManifestConfirmConditionNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the * manifest conditioning instructions that you provide in the setting MCC XML (mccXml). + * + * @var EsamManifestConfirmConditionNotification|null */ private $manifestConfirmConditionNotification; @@ -17,12 +19,16 @@ final class EsamSettings * Specifies the stream distance, in milliseconds, between the SCTE 35 messages that the transcoder places and the * splice points that they refer to. If the time between the start of the asset and the SCTE-35 message is less than * this value, then the transcoder places the SCTE-35 marker at the beginning of the stream. + * + * @var int|null */ private $responseSignalPreroll; /** * Specifies an ESAM SignalProcessingNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the signal * processing instructions that you provide in the setting SCC XML (sccXml). + * + * @var EsamSignalProcessingNotification|null */ private $signalProcessingNotification; diff --git a/src/Service/MediaConvert/src/ValueObject/EsamSignalProcessingNotification.php b/src/Service/MediaConvert/src/ValueObject/EsamSignalProcessingNotification.php index 6b00b88b5..45bad7b52 100644 --- a/src/Service/MediaConvert/src/ValueObject/EsamSignalProcessingNotification.php +++ b/src/Service/MediaConvert/src/ValueObject/EsamSignalProcessingNotification.php @@ -14,6 +14,8 @@ final class EsamSignalProcessingNotification * file outputs, if you want the service to place SCTE-35 markers at the insertion points you specify in the XML * document, you must also enable SCTE-35 ESAM (scte35Esam). Note that you can either specify an ESAM XML document or * enable SCTE-35 passthrough. You can't do both. + * + * @var string|null */ private $sccXml; diff --git a/src/Service/MediaConvert/src/ValueObject/ExtendedDataServices.php b/src/Service/MediaConvert/src/ValueObject/ExtendedDataServices.php index 952874639..cdacb7085 100644 --- a/src/Service/MediaConvert/src/ValueObject/ExtendedDataServices.php +++ b/src/Service/MediaConvert/src/ValueObject/ExtendedDataServices.php @@ -16,12 +16,16 @@ final class ExtendedDataServices /** * The action to take on copy and redistribution control XDS packets. If you select PASSTHROUGH, packets will not be * changed. If you select STRIP, any packets will be removed in output captions. + * + * @var CopyProtectionAction::*|null */ private $copyProtectionAction; /** * The action to take on content advisory XDS packets. If you select PASSTHROUGH, packets will not be changed. If you * select STRIP, any packets will be removed in output captions. + * + * @var VchipAction::*|null */ private $vchipAction; diff --git a/src/Service/MediaConvert/src/ValueObject/F4vSettings.php b/src/Service/MediaConvert/src/ValueObject/F4vSettings.php index 2daa18fce..13bb584b6 100644 --- a/src/Service/MediaConvert/src/ValueObject/F4vSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/F4vSettings.php @@ -13,6 +13,8 @@ final class F4vSettings /** * If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for * progressive downloading. Otherwise it is placed normally at the end. + * + * @var F4vMoovPlacement::*|null */ private $moovPlacement; diff --git a/src/Service/MediaConvert/src/ValueObject/FileGroupSettings.php b/src/Service/MediaConvert/src/ValueObject/FileGroupSettings.php index 241e1d4ba..727825661 100644 --- a/src/Service/MediaConvert/src/ValueObject/FileGroupSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/FileGroupSettings.php @@ -13,11 +13,15 @@ final class FileGroupSettings * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts * format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the * input file. If your job has multiple inputs, the service uses the filename of the first input file. + * + * @var string|null */ private $destination; /** * Settings associated with the destination. Will vary based on the type of destination. + * + * @var DestinationSettings|null */ private $destinationSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/FileSourceSettings.php b/src/Service/MediaConvert/src/ValueObject/FileSourceSettings.php index dd3fd2f78..d5d440028 100644 --- a/src/Service/MediaConvert/src/ValueObject/FileSourceSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/FileSourceSettings.php @@ -18,6 +18,8 @@ final class FileSourceSettings * Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose * Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the * 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708. + * + * @var FileSourceConvert608To708::*|null */ private $convert608To708; @@ -25,6 +27,8 @@ final class FileSourceSettings * Choose the presentation style of your input SCC captions. To use the same presentation style as your input: Keep the * default value, Disabled. To convert paint-on captions to pop-on: Choose Enabled. We also recommend that you choose * Enabled if you notice additional repeated lines in your output captions. + * + * @var CaptionSourceConvertPaintOnToPopOn::*|null */ private $convertPaintToPop; @@ -34,12 +38,16 @@ final class FileSourceSettings * a fraction. When you work directly in your JSON job specification, use the settings framerateNumerator and * framerateDenominator. For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 * fps, or 30000 / 1001 for 29.97 fps. + * + * @var CaptionSourceFramerate|null */ private $framerate; /** * External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', * 'xml', 'smi', 'webvtt', and 'vtt'. + * + * @var string|null */ private $sourceFile; @@ -53,6 +61,8 @@ final class FileSourceSettings * sources, such as SCC and STL, and your time delta isn't a multiple of the input frame rate, MediaConvert snaps the * captions to the nearest frame. For example, when your input video frame rate is 25 fps and you specify 1010ms for * time delta, MediaConvert delays your captions by 1000 ms. + * + * @var int|null */ private $timeDelta; @@ -60,6 +70,8 @@ final class FileSourceSettings * When you use the setting Time delta (TimeDelta) to adjust the sync between your sidecar captions and your video, use * this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units * (TimeDeltaUnits), MediaConvert uses seconds by default. + * + * @var FileSourceTimeDeltaUnits::*|null */ private $timeDeltaUnits; diff --git a/src/Service/MediaConvert/src/ValueObject/ForceIncludeRenditionSize.php b/src/Service/MediaConvert/src/ValueObject/ForceIncludeRenditionSize.php index d9703d9f9..775a0b712 100644 --- a/src/Service/MediaConvert/src/ValueObject/ForceIncludeRenditionSize.php +++ b/src/Service/MediaConvert/src/ValueObject/ForceIncludeRenditionSize.php @@ -15,11 +15,15 @@ final class ForceIncludeRenditionSize { /** * Use Height to define the video resolution height, in pixels, for this rule. + * + * @var int|null */ private $height; /** * Use Width to define the video resolution width, in pixels, for this rule. + * + * @var int|null */ private $width; diff --git a/src/Service/MediaConvert/src/ValueObject/FrameCaptureSettings.php b/src/Service/MediaConvert/src/ValueObject/FrameCaptureSettings.php index abe366a8a..4b4d45373 100644 --- a/src/Service/MediaConvert/src/ValueObject/FrameCaptureSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/FrameCaptureSettings.php @@ -12,6 +12,8 @@ final class FrameCaptureSettings * framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and * framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files * will be named as filename.n.jpg where n is the 0-based sequence number of each Capture. + * + * @var int|null */ private $framerateDenominator; @@ -20,16 +22,22 @@ final class FrameCaptureSettings * framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and * framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files * will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places. + * + * @var int|null */ private $framerateNumerator; /** * Maximum number of captures (encoded jpg output files). + * + * @var int|null */ private $maxCaptures; /** * JPEG Quality - a higher value equals higher quality. + * + * @var int|null */ private $quality; diff --git a/src/Service/MediaConvert/src/ValueObject/H264QvbrSettings.php b/src/Service/MediaConvert/src/ValueObject/H264QvbrSettings.php index 96f412ec0..ea363ccaa 100644 --- a/src/Service/MediaConvert/src/ValueObject/H264QvbrSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/H264QvbrSettings.php @@ -13,6 +13,8 @@ final class H264QvbrSettings * bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part * of this output to the value that you choose. That is, the total size of the video element is less than or equal to * the value you set multiplied by the number of seconds of encoded output. + * + * @var int|null */ private $maxAverageBitrate; @@ -25,6 +27,8 @@ final class H264QvbrSettings * broadcast-quality transcodes is between 6 and 9. Optionally, to specify a value between whole numbers, also provide a * value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set * qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. + * + * @var int|null */ private $qvbrQualityLevel; @@ -33,6 +37,8 @@ final class H264QvbrSettings * want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. * MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set * qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. + * + * @var float|null */ private $qvbrQualityLevelFineTune; diff --git a/src/Service/MediaConvert/src/ValueObject/H264Settings.php b/src/Service/MediaConvert/src/ValueObject/H264Settings.php index 9bd2da9dc..f8acb40b4 100644 --- a/src/Service/MediaConvert/src/ValueObject/H264Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/H264Settings.php @@ -41,6 +41,8 @@ final class H264Settings * transcode, set Adaptive quantization (H264AdaptiveQuantization) to Off (OFF). Related settings: The value that you * choose here applies to the following settings: H264FlickerAdaptiveQuantization, H264SpatialAdaptiveQuantization, and * H264TemporalAdaptiveQuantization. + * + * @var H264AdaptiveQuantization::*|null */ private $adaptiveQuantization; @@ -50,23 +52,31 @@ final class H264Settings * the video quality of outputs with other rate control modes relative to the bitrate that you specify. Bandwidth * reduction increases further when your input is low quality or noisy. Outputs that use this feature incur pro-tier * pricing. When you include Bandwidth reduction filter, you cannot include the Noise reducer preprocessor. + * + * @var BandwidthReductionFilter|null */ private $bandwidthReductionFilter; /** * Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be * unique when rounded down to the nearest multiple of 1000. + * + * @var int|null */ private $bitrate; /** * Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, * choose Auto (AUTO). + * + * @var H264CodecLevel::*|null */ private $codecLevel; /** * H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License. + * + * @var H264CodecProfile::*|null */ private $codecProfile; @@ -76,11 +86,15 @@ final class H264Settings * keep the default value Adaptive. MediaConvert will use fewer B-frames for high-motion video content than low-motion * content. The maximum number of B- frames is limited by the value that you choose for B-frames between reference * frames. To use the same number B-frames for all types of content: Choose Static. + * + * @var H264DynamicSubGop::*|null */ private $dynamicSubGop; /** * Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC. + * + * @var H264EntropyEncoding::*|null */ private $entropyEncoding; @@ -88,6 +102,8 @@ final class H264Settings * The video encoding method for your MPEG-4 AVC output. Keep the default value, PAFF, to have MediaConvert use PAFF * encoding for interlaced outputs. Choose Force field (FORCE_FIELD) to disable PAFF encoding and create separate * interlaced fields. Choose MBAFF to disable PAFF and have MediaConvert use MBAFF encoding for interlaced outputs. + * + * @var H264FieldEncoding::*|null */ private $fieldEncoding; @@ -101,6 +117,8 @@ final class H264Settings * then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more * often to smooth out the flicker. To manually enable or disable H264FlickerAdaptiveQuantization, you must set Adaptive * quantization (H264AdaptiveQuantization) to a value other than AUTO. + * + * @var H264FlickerAdaptiveQuantization::*|null */ private $flickerAdaptiveQuantization; @@ -113,6 +131,8 @@ final class H264Settings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var H264FramerateControl::*|null */ private $framerateControl; @@ -125,6 +145,8 @@ final class H264Settings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var H264FramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -133,6 +155,8 @@ final class H264Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -141,6 +165,8 @@ final class H264Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; @@ -149,6 +175,8 @@ final class H264Settings * structure has 1 or more B-frames: Leave blank or keep the default value Enabled. We recommend that you choose Enabled * to help improve the video quality of your output relative to its bitrate. To not use reference B-frames: Choose * Disabled. + * + * @var H264GopBReference::*|null */ private $gopBreference; @@ -158,6 +186,8 @@ final class H264Settings * choose this value for you based on characteristics of your input video. To enable this automatic behavior, keep the * default value by leaving this setting out of your JSON job specification. In the console, do this by keeping the * default empty value. If you do explicitly specify a value, for segmented outputs, don't set this value to 0. + * + * @var int|null */ private $gopClosedCadence; @@ -168,6 +198,8 @@ final class H264Settings * If you want to allow MediaConvert to automatically determine GOP size, leave GOP size blank and set GOP mode control * to Auto (AUTO). If your output group specifies HLS, DASH, or CMAF, leave GOP size blank and set GOP mode control to * Auto in each output in your output group. + * + * @var float|null */ private $gopSize; @@ -179,6 +211,8 @@ final class H264Settings * set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the * GOP length, choose Specified, frames (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the * related setting GOP size (GopSize). + * + * @var H264GopSizeUnits::*|null */ private $gopSizeUnits; @@ -186,16 +220,22 @@ final class H264Settings * If your downstream systems have strict buffer requirements: Specify the minimum percentage of the HRD buffer that's * available at the end of each encoded video segment. For the best video quality: Set to 0 or leave blank to * automatically determine the final buffer fill percentage. + * + * @var int|null */ private $hrdBufferFinalFillPercentage; /** * Percentage of the buffer that should initially be filled (HRD buffer model). + * + * @var int|null */ private $hrdBufferInitialFillPercentage; /** * Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. + * + * @var int|null */ private $hrdBufferSize; @@ -208,12 +248,16 @@ final class H264Settings * Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the * same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field * first, depending on which of the Follow options you choose. + * + * @var H264InterlaceMode::*|null */ private $interlaceMode; /** * Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control * mode is QVBR. + * + * @var int|null */ private $maxBitrate; @@ -229,6 +273,8 @@ final class H264Settings * GOP is shrunk slightly and one GOP is stretched slightly. When the cadence-driven I-frames are farther from the * scene-change I-frame than the value you set, then the encoder leaves all I-frames in place and the GOPs surrounding * the scene change are smaller than the usual cadence GOPs. + * + * @var int|null */ private $minIinterval; @@ -236,12 +282,16 @@ final class H264Settings * Specify the number of B-frames between reference frames in this output. For the best video quality: Leave blank. * MediaConvert automatically determines the number of B-frames to use based on the characteristics of your input video. * To manually specify the number of B-frames between reference frames: Enter an integer from 0 to 7. + * + * @var int|null */ private $numberBframesBetweenReferenceFrames; /** * Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced * encoding. + * + * @var int|null */ private $numberReferenceFrames; @@ -251,6 +301,8 @@ final class H264Settings * PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job * specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the * parNumerator and parDenominator settings. + * + * @var H264ParControl::*|null */ private $parControl; @@ -259,6 +311,8 @@ final class H264Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parDenominator is 33. + * + * @var int|null */ private $parDenominator; @@ -267,6 +321,8 @@ final class H264Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parNumerator is 40. + * + * @var int|null */ private $parNumerator; @@ -276,23 +332,31 @@ final class H264Settings * between encoding speed and video quality: Leave blank or keep the default value Single pass HQ. For the best video * quality, at the cost of encoding speed: Choose Multi pass HQ. MediaConvert performs an analysis pass on your input * followed by an encoding pass. Outputs that use this feature incur pro-tier pricing. + * + * @var H264QualityTuningLevel::*|null */ private $qualityTuningLevel; /** * Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set * QVBR for Rate control mode (RateControlMode). + * + * @var H264QvbrSettings|null */ private $qvbrSettings; /** * Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or * quality-defined variable bitrate (QVBR). + * + * @var H264RateControlMode::*|null */ private $rateControlMode; /** * Places a PPS header on each encoded picture, even if repeated. + * + * @var H264RepeatPps::*|null */ private $repeatPps; @@ -306,6 +370,8 @@ final class H264Settings * basic interlacing. Required settings: To use optimized interlacing, you must set Telecine (telecine) to None (NONE) * or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode * (interlaceMode) to a value other than Progressive (PROGRESSIVE). + * + * @var H264ScanTypeConversionMode::*|null */ private $scanTypeConversionMode; @@ -314,12 +380,16 @@ final class H264Settings * quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for * further video quality improvement. For more information about QVBR, see * https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. + * + * @var H264SceneChangeDetect::*|null */ private $sceneChangeDetect; /** * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, * and less than or equal to half the number of macroblock rows for interlaced pictures. + * + * @var int|null */ private $slices; @@ -329,6 +399,8 @@ final class H264Settings * keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. * Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to * (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. + * + * @var H264SlowPal::*|null */ private $slowPal; @@ -340,6 +412,8 @@ final class H264Settings * Choose the value 1 or 16 to use the default JVT softening quantization matricies from the H.264 specification. Choose * a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction * of high-frequency data. The value 128 results in the softest video. + * + * @var int|null */ private $softness; @@ -360,11 +434,15 @@ final class H264Settings * it to Low. For content with a wider variety of textures, set it to High or Higher. To manually enable or disable * H264SpatialAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than * AUTO. + * + * @var H264SpatialAdaptiveQuantization::*|null */ private $spatialAdaptiveQuantization; /** * Produces a bitstream compliant with SMPTE RP-2027. + * + * @var H264Syntax::*|null */ private $syntax; @@ -375,6 +453,8 @@ final class H264Settings * player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does * a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother * picture. + * + * @var H264Telecine::*|null */ private $telecine; @@ -394,11 +474,15 @@ final class H264Settings * the setting Adaptive quantization (adaptiveQuantization). To manually enable or disable * H264TemporalAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than * AUTO. + * + * @var H264TemporalAdaptiveQuantization::*|null */ private $temporalAdaptiveQuantization; /** * Inserts timecode for each frame as 4 bytes of an unregistered SEI message. + * + * @var H264UnregisteredSeiTimecode::*|null */ private $unregisteredSeiTimecode; diff --git a/src/Service/MediaConvert/src/ValueObject/H265QvbrSettings.php b/src/Service/MediaConvert/src/ValueObject/H265QvbrSettings.php index aba9eb172..7d631e9dc 100644 --- a/src/Service/MediaConvert/src/ValueObject/H265QvbrSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/H265QvbrSettings.php @@ -13,6 +13,8 @@ final class H265QvbrSettings * bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part * of this output to the value that you choose. That is, the total size of the video element is less than or equal to * the value you set multiplied by the number of seconds of encoded output. + * + * @var int|null */ private $maxAverageBitrate; @@ -25,6 +27,8 @@ final class H265QvbrSettings * broadcast-quality transcodes is between 6 and 9. Optionally, to specify a value between whole numbers, also provide a * value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set * qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. + * + * @var int|null */ private $qvbrQualityLevel; @@ -33,6 +37,8 @@ final class H265QvbrSettings * want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. * MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set * qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. + * + * @var float|null */ private $qvbrQualityLevelFineTune; diff --git a/src/Service/MediaConvert/src/ValueObject/H265Settings.php b/src/Service/MediaConvert/src/ValueObject/H265Settings.php index 8a2b85554..0e027e8bf 100644 --- a/src/Service/MediaConvert/src/ValueObject/H265Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/H265Settings.php @@ -42,12 +42,16 @@ final class H265Settings * (H265SpatialAdaptiveQuantization), Temporal Adaptive Quantization (H265TemporalAdaptiveQuantization), and Flicker * Adaptive Quantization (H265FlickerAdaptiveQuantization), to further control the quantization filter. Set Adaptive * Quantization to Off (OFF) to apply no quantization to your output. + * + * @var H265AdaptiveQuantization::*|null */ private $adaptiveQuantization; /** * Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer * Function (EOTF). + * + * @var H265AlternateTransferFunctionSei::*|null */ private $alternateTransferFunctionSei; @@ -57,23 +61,31 @@ final class H265Settings * the video quality of outputs with other rate control modes relative to the bitrate that you specify. Bandwidth * reduction increases further when your input is low quality or noisy. Outputs that use this feature incur pro-tier * pricing. When you include Bandwidth reduction filter, you cannot include the Noise reducer preprocessor. + * + * @var BandwidthReductionFilter|null */ private $bandwidthReductionFilter; /** * Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be * unique when rounded down to the nearest multiple of 1000. + * + * @var int|null */ private $bitrate; /** * H.265 Level. + * + * @var H265CodecLevel::*|null */ private $codecLevel; /** * Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so * "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License. + * + * @var H265CodecProfile::*|null */ private $codecProfile; @@ -83,6 +95,8 @@ final class H265Settings * keep the default value Adaptive. MediaConvert will use fewer B-frames for high-motion video content than low-motion * content. The maximum number of B- frames is limited by the value that you choose for B-frames between reference * frames. To use the same number B-frames for all types of content: Choose Static. + * + * @var H265DynamicSubGop::*|null */ private $dynamicSubGop; @@ -92,6 +106,8 @@ final class H265Settings * the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out * the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must * also set adaptiveQuantization to a value other than Off (OFF). + * + * @var H265FlickerAdaptiveQuantization::*|null */ private $flickerAdaptiveQuantization; @@ -104,6 +120,8 @@ final class H265Settings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var H265FramerateControl::*|null */ private $framerateControl; @@ -116,6 +134,8 @@ final class H265Settings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var H265FramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -124,6 +144,8 @@ final class H265Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -132,6 +154,8 @@ final class H265Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; @@ -140,6 +164,8 @@ final class H265Settings * structure has 1 or more B-frames: Leave blank or keep the default value Enabled. We recommend that you choose Enabled * to help improve the video quality of your output relative to its bitrate. To not use reference B-frames: Choose * Disabled. + * + * @var H265GopBReference::*|null */ private $gopBreference; @@ -149,6 +175,8 @@ final class H265Settings * choose this value for you based on characteristics of your input video. To enable this automatic behavior, keep the * default value by leaving this setting out of your JSON job specification. In the console, do this by keeping the * default empty value. If you do explicitly specify a value, for segmented outputs, don't set this value to 0. + * + * @var int|null */ private $gopClosedCadence; @@ -159,6 +187,8 @@ final class H265Settings * If you want to allow MediaConvert to automatically determine GOP size, leave GOP size blank and set GOP mode control * to Auto (AUTO). If your output group specifies HLS, DASH, or CMAF, leave GOP size blank and set GOP mode control to * Auto in each output in your output group. + * + * @var float|null */ private $gopSize; @@ -170,6 +200,8 @@ final class H265Settings * set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the * GOP length, choose Specified, frames (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the * related setting GOP size (GopSize). + * + * @var H265GopSizeUnits::*|null */ private $gopSizeUnits; @@ -177,16 +209,22 @@ final class H265Settings * If your downstream systems have strict buffer requirements: Specify the minimum percentage of the HRD buffer that's * available at the end of each encoded video segment. For the best video quality: Set to 0 or leave blank to * automatically determine the final buffer fill percentage. + * + * @var int|null */ private $hrdBufferFinalFillPercentage; /** * Percentage of the buffer that should initially be filled (HRD buffer model). + * + * @var int|null */ private $hrdBufferInitialFillPercentage; /** * Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. + * + * @var int|null */ private $hrdBufferSize; @@ -199,12 +237,16 @@ final class H265Settings * Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the * same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field * first, depending on which of the Follow options you choose. + * + * @var H265InterlaceMode::*|null */ private $interlaceMode; /** * Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control * mode is QVBR. + * + * @var int|null */ private $maxBitrate; @@ -220,6 +262,8 @@ final class H265Settings * GOP is shrunk slightly and one GOP is stretched slightly. When the cadence-driven I-frames are farther from the * scene-change I-frame than the value you set, then the encoder leaves all I-frames in place and the GOPs surrounding * the scene change are smaller than the usual cadence GOPs. + * + * @var int|null */ private $minIinterval; @@ -227,12 +271,16 @@ final class H265Settings * Specify the number of B-frames between reference frames in this output. For the best video quality: Leave blank. * MediaConvert automatically determines the number of B-frames to use based on the characteristics of your input video. * To manually specify the number of B-frames between reference frames: Enter an integer from 0 to 7. + * + * @var int|null */ private $numberBframesBetweenReferenceFrames; /** * Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced * encoding. + * + * @var int|null */ private $numberReferenceFrames; @@ -242,6 +290,8 @@ final class H265Settings * PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job * specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the * parNumerator and parDenominator settings. + * + * @var H265ParControl::*|null */ private $parControl; @@ -250,6 +300,8 @@ final class H265Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parDenominator is 33. + * + * @var int|null */ private $parDenominator; @@ -258,30 +310,40 @@ final class H265Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parNumerator is 40. + * + * @var int|null */ private $parNumerator; /** * Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output * video quality. The default behavior is faster, lower quality, single-pass encoding. + * + * @var H265QualityTuningLevel::*|null */ private $qualityTuningLevel; /** * Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set * QVBR for Rate control mode (RateControlMode). + * + * @var H265QvbrSettings|null */ private $qvbrSettings; /** * Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or * quality-defined variable bitrate (QVBR). + * + * @var H265RateControlMode::*|null */ private $rateControlMode; /** * Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on * content. + * + * @var H265SampleAdaptiveOffsetFilterMode::*|null */ private $sampleAdaptiveOffsetFilterMode; @@ -295,6 +357,8 @@ final class H265Settings * basic interlacing. Required settings: To use optimized interlacing, you must set Telecine (telecine) to None (NONE) * or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode * (interlaceMode) to a value other than Progressive (PROGRESSIVE). + * + * @var H265ScanTypeConversionMode::*|null */ private $scanTypeConversionMode; @@ -303,12 +367,16 @@ final class H265Settings * quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for * further video quality improvement. For more information about QVBR, see * https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. + * + * @var H265SceneChangeDetect::*|null */ private $sceneChangeDetect; /** * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, * and less than or equal to half the number of macroblock rows for interlaced pictures. + * + * @var int|null */ private $slices; @@ -318,6 +386,8 @@ final class H265Settings * keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. * Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to * (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. + * + * @var H265SlowPal::*|null */ private $slowPal; @@ -332,6 +402,8 @@ final class H265Settings * setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization * (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it * to Low. For content with a wider variety of textures, set it to High or Higher. + * + * @var H265SpatialAdaptiveQuantization::*|null */ private $spatialAdaptiveQuantization; @@ -341,6 +413,8 @@ final class H265Settings * Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard * Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player * converts this output to 29.97i. + * + * @var H265Telecine::*|null */ private $telecine; @@ -354,6 +428,8 @@ final class H265Settings * objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: * When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization * (adaptiveQuantization). + * + * @var H265TemporalAdaptiveQuantization::*|null */ private $temporalAdaptiveQuantization; @@ -364,16 +440,22 @@ final class H265Settings * example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could * decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame * rate output. + * + * @var H265TemporalIds::*|null */ private $temporalIds; /** * Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures. + * + * @var H265Tiles::*|null */ private $tiles; /** * Inserts timecode for each frame as 4 bytes of an unregistered SEI message. + * + * @var H265UnregisteredSeiTimecode::*|null */ private $unregisteredSeiTimecode; @@ -385,6 +467,8 @@ final class H265Settings * headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might not work * properly with some downstream systems and video players. The service defaults to marking your output as HEV1. For * these outputs, the service writes parameter set NAL units directly into the samples. + * + * @var H265WriteMp4PackagingType::*|null */ private $writeMp4PackagingType; diff --git a/src/Service/MediaConvert/src/ValueObject/Hdr10Metadata.php b/src/Service/MediaConvert/src/ValueObject/Hdr10Metadata.php index 3e21414e1..4b45c4112 100644 --- a/src/Service/MediaConvert/src/ValueObject/Hdr10Metadata.php +++ b/src/Service/MediaConvert/src/ValueObject/Hdr10Metadata.php @@ -12,70 +12,94 @@ final class Hdr10Metadata /** * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, * each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + * + * @var int|null */ private $bluePrimaryX; /** * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, * each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + * + * @var int|null */ private $bluePrimaryY; /** * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, * each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + * + * @var int|null */ private $greenPrimaryX; /** * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, * each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + * + * @var int|null */ private $greenPrimaryY; /** * Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This * setting doesn't have a default value; you must specify a value that is suitable for the content. + * + * @var int|null */ private $maxContentLightLevel; /** * Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. This * setting doesn't have a default value; you must specify a value that is suitable for the content. + * + * @var int|null */ private $maxFrameAverageLightLevel; /** * Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter. + * + * @var int|null */ private $maxLuminance; /** * Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter. + * + * @var int|null */ private $minLuminance; /** * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, * each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + * + * @var int|null */ private $redPrimaryX; /** * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, * each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + * + * @var int|null */ private $redPrimaryY; /** * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, * each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + * + * @var int|null */ private $whitePointX; /** * HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, * each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction. + * + * @var int|null */ private $whitePointY; diff --git a/src/Service/MediaConvert/src/ValueObject/Hdr10Plus.php b/src/Service/MediaConvert/src/ValueObject/Hdr10Plus.php index c5eb10b59..b514729f5 100644 --- a/src/Service/MediaConvert/src/ValueObject/Hdr10Plus.php +++ b/src/Service/MediaConvert/src/ValueObject/Hdr10Plus.php @@ -10,12 +10,16 @@ final class Hdr10Plus /** * Specify the HDR10+ mastering display normalized peak luminance, in nits. This is the normalized actual peak luminance * of the mastering display, as defined by ST 2094-40. + * + * @var int|null */ private $masteringMonitorNits; /** * Specify the HDR10+ target display nominal peak luminance, in nits. This is the nominal maximum luminance of the * target display as defined by ST 2094-40. + * + * @var int|null */ private $targetMonitorNits; diff --git a/src/Service/MediaConvert/src/ValueObject/HlsAdditionalManifest.php b/src/Service/MediaConvert/src/ValueObject/HlsAdditionalManifest.php index fce72db59..8a36ee3bd 100644 --- a/src/Service/MediaConvert/src/ValueObject/HlsAdditionalManifest.php +++ b/src/Service/MediaConvert/src/ValueObject/HlsAdditionalManifest.php @@ -15,11 +15,15 @@ final class HlsAdditionalManifest * top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier that is * different from the nameModifier of the output. The service uses the output name modifier to create unique names for * the individual variant manifests. + * + * @var string|null */ private $manifestNameModifier; /** * Specify the outputs that you want this additional top-level manifest to reference. + * + * @var string[]|null */ private $selectedOutputs; diff --git a/src/Service/MediaConvert/src/ValueObject/HlsCaptionLanguageMapping.php b/src/Service/MediaConvert/src/ValueObject/HlsCaptionLanguageMapping.php index 87b3cfdc9..21e58c827 100644 --- a/src/Service/MediaConvert/src/ValueObject/HlsCaptionLanguageMapping.php +++ b/src/Service/MediaConvert/src/ValueObject/HlsCaptionLanguageMapping.php @@ -12,22 +12,30 @@ final class HlsCaptionLanguageMapping { /** * Caption channel. + * + * @var int|null */ private $captionChannel; /** * Specify the language for this captions channel, using the ISO 639-2 or ISO 639-3 three-letter language code. + * + * @var string|null */ private $customLanguageCode; /** * Specify the language, using the ISO 639-2 three-letter code listed at * https://www.loc.gov/standards/iso639-2/php/code_list.php. + * + * @var LanguageCode::*|null */ private $languageCode; /** * Caption language description. + * + * @var string|null */ private $languageDescription; diff --git a/src/Service/MediaConvert/src/ValueObject/HlsEncryptionSettings.php b/src/Service/MediaConvert/src/ValueObject/HlsEncryptionSettings.php index 2953b1ca1..7d1c67650 100644 --- a/src/Service/MediaConvert/src/ValueObject/HlsEncryptionSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/HlsEncryptionSettings.php @@ -16,41 +16,55 @@ final class HlsEncryptionSettings /** * This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the * Initialization Vector will follow the segment number by default. + * + * @var string|null */ private $constantInitializationVector; /** * Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web * interface also disables encryption. + * + * @var HlsEncryptionType::*|null */ private $encryptionMethod; /** * The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to * INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest. + * + * @var HlsInitializationVectorInManifest::*|null */ private $initializationVectorInManifest; /** * Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple * HLS FairPlay content protection. + * + * @var HlsOfflineEncrypted::*|null */ private $offlineEncrypted; /** * If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a * SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead. + * + * @var SpekeKeyProvider|null */ private $spekeKeyProvider; /** * Use these settings to set up encryption with a static key provider. + * + * @var StaticKeyProvider|null */ private $staticKeyProvider; /** * Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more * information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. + * + * @var HlsKeyProviderType::*|null */ private $type; diff --git a/src/Service/MediaConvert/src/ValueObject/HlsGroupSettings.php b/src/Service/MediaConvert/src/ValueObject/HlsGroupSettings.php index 3562b9d54..7a0592380 100644 --- a/src/Service/MediaConvert/src/ValueObject/HlsGroupSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/HlsGroupSettings.php @@ -33,6 +33,8 @@ final class HlsGroupSettings /** * Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether * SCTE-35 markers appear in the outputs themselves. + * + * @var list|null */ private $adMarkers; @@ -40,6 +42,8 @@ final class HlsGroupSettings * By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default * manifest references every output in the output group. To create additional top-level manifests that reference a * subset of the outputs in the output group, specify a list of them here. + * + * @var HlsAdditionalManifest[]|null */ private $additionalManifests; @@ -47,17 +51,23 @@ final class HlsGroupSettings * Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the * default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only * headers from your audio segments. + * + * @var HlsAudioOnlyHeader::*|null */ private $audioOnlyHeader; /** * A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is * delivered from a different URL than the main .m3u8 file. + * + * @var string|null */ private $baseUrl; /** * Language to be used on Caption outputs. + * + * @var HlsCaptionLanguageMapping[]|null */ private $captionLanguageMappings; @@ -68,6 +78,8 @@ final class HlsGroupSettings * embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages * in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the * manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest. + * + * @var HlsCaptionLanguageSetting::*|null */ private $captionLanguageSetting; @@ -76,6 +88,8 @@ final class HlsGroupSettings * segments that align with the video segments from the first video output in this output group. For example, if the * video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large * segments (LARGE_SEGMENTS) to create caption segments that are 300 seconds long. + * + * @var HlsCaptionSegmentLengthControl::*|null */ private $captionSegmentLengthControl; @@ -83,11 +97,15 @@ final class HlsGroupSettings * Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default * value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control * http header. + * + * @var HlsClientCache::*|null */ private $clientCache; /** * Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. + * + * @var HlsCodecSpecification::*|null */ private $codecSpecification; @@ -95,21 +113,29 @@ final class HlsGroupSettings * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts * format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the * input file. If your job has multiple inputs, the service uses the filename of the first input file. + * + * @var string|null */ private $destination; /** * Settings associated with the destination. Will vary based on the type of destination. + * + * @var DestinationSettings|null */ private $destinationSettings; /** * Indicates whether segments should be placed in subdirectories. + * + * @var HlsDirectoryStructure::*|null */ private $directoryStructure; /** * DRM settings. + * + * @var HlsEncryptionSettings|null */ private $encryption; @@ -121,21 +147,29 @@ final class HlsGroupSettings * manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that * MediaConvert creates with this feature are compatible with this Roku specification: * https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md. + * + * @var HlsImageBasedTrickPlay::*|null */ private $imageBasedTrickPlay; /** * Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED. + * + * @var HlsImageBasedTrickPlaySettings|null */ private $imageBasedTrickPlaySettings; /** * When set to GZIP, compresses HLS playlist. + * + * @var HlsManifestCompression::*|null */ private $manifestCompression; /** * Indicates whether the output manifest should use floating point values for segment duration. + * + * @var HlsManifestDurationFormat::*|null */ private $manifestDurationFormat; @@ -147,17 +181,23 @@ final class HlsGroupSettings * this setting, the encoder will combine any final segment that is shorter than the length that you specify with the * previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a * minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds. + * + * @var float|null */ private $minFinalSegmentLength; /** * When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail * and extending the segment size if needed. + * + * @var int|null */ private $minSegmentLength; /** * Indicates whether the .m3u8 manifest file should be generated for this HLS output group. + * + * @var HlsOutputSelection::*|null */ private $outputSelection; @@ -165,11 +205,15 @@ final class HlsGroupSettings * Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either * the program date and time are initialized using the input timecode source, or the time is initialized using the input * timecode source and the date is initialized using the timestamp_offset. + * + * @var HlsProgramDateTime::*|null */ private $programDateTime; /** * Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. + * + * @var int|null */ private $programDateTimePeriod; @@ -181,12 +225,16 @@ final class HlsGroupSettings * The parent manifest includes the latest BANDWIDTH and AVERAGE-BANDWIDTH attributes, and child manifests include the * latest available media segment. When your job completes, the final child playlists include an EXT-X-ENDLIST tag. To * generate HLS manifests only when your job completes: Choose Disabled. + * + * @var HlsProgressiveWriteHlsManifest::*|null */ private $progressiveWriteHlsManifest; /** * When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index * segment for playback. + * + * @var HlsSegmentControl::*|null */ private $segmentControl; @@ -195,6 +243,8 @@ final class HlsGroupSettings * Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this * value strictly. Use Segment control (HlsSegmentControl) to specify whether MediaConvert creates separate segment * files or one content file that has metadata to mark the segment boundaries. + * + * @var int|null */ private $segmentLength; @@ -203,17 +253,23 @@ final class HlsGroupSettings * exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. * Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP * boundary. + * + * @var HlsSegmentLengthControl::*|null */ private $segmentLengthControl; /** * Specify the number of segments to write to a subdirectory before starting a new one. You must also set Directory * structure to Subdirectory per stream for this setting to have an effect. + * + * @var int|null */ private $segmentsPerSubdirectory; /** * Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. + * + * @var HlsStreamInfResolution::*|null */ private $streamInfResolution; @@ -224,6 +280,8 @@ final class HlsGroupSettings * may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual * duration of the segment. Some older players may experience interrupted playback when the actual duration of a track * in a segment is longer than the target duration. + * + * @var HlsTargetDurationCompatibilityMode::*|null */ private $targetDurationCompatibilityMode; @@ -231,6 +289,8 @@ final class HlsGroupSettings * Specify the type of the ID3 frame (timedMetadataId3Frame) to use for ID3 timestamps (timedMetadataId3Period) in your * output. To include ID3 timestamps: Specify PRIV (PRIV) or TDRL (TDRL) and set ID3 metadata (timedMetadata) to * Passthrough (PASSTHROUGH). To exclude ID3 timestamps: Set ID3 timestamp frame type to None (NONE). + * + * @var HlsTimedMetadataId3Frame::*|null */ private $timedMetadataId3Frame; @@ -239,11 +299,15 @@ final class HlsGroupSettings * timecode and date, and increases incrementally with each ID3 timestamp. To use the default interval of 10 seconds: * Leave blank. To include this metadata in your output: Set ID3 timestamp frame type (timedMetadataId3Frame) to PRIV * (PRIV) or TDRL (TDRL), and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). + * + * @var int|null */ private $timedMetadataId3Period; /** * Provides an extra millisecond delta offset to fine tune the timestamps. + * + * @var int|null */ private $timestampDeltaMilliseconds; diff --git a/src/Service/MediaConvert/src/ValueObject/HlsImageBasedTrickPlaySettings.php b/src/Service/MediaConvert/src/ValueObject/HlsImageBasedTrickPlaySettings.php index b23d3b798..747683e60 100644 --- a/src/Service/MediaConvert/src/ValueObject/HlsImageBasedTrickPlaySettings.php +++ b/src/Service/MediaConvert/src/ValueObject/HlsImageBasedTrickPlaySettings.php @@ -14,6 +14,8 @@ final class HlsImageBasedTrickPlaySettings * The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates * thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert * generates thumbnails according to the interval you specify in thumbnailInterval. + * + * @var HlsIntervalCadence::*|null */ private $intervalCadence; @@ -21,6 +23,8 @@ final class HlsImageBasedTrickPlaySettings * Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail * width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be * rejected. Must be divisible by 2. + * + * @var int|null */ private $thumbnailHeight; @@ -29,21 +33,29 @@ final class HlsImageBasedTrickPlaySettings * align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. * For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame * interval to generate thumbnails. + * + * @var float|null */ private $thumbnailInterval; /** * Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. + * + * @var int|null */ private $thumbnailWidth; /** * Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. + * + * @var int|null */ private $tileHeight; /** * Number of thumbnails in each row of a tile image. Set a value between 1 and 512. + * + * @var int|null */ private $tileWidth; diff --git a/src/Service/MediaConvert/src/ValueObject/HlsRenditionGroupSettings.php b/src/Service/MediaConvert/src/ValueObject/HlsRenditionGroupSettings.php index 0d59de7bc..4fac9f05b 100644 --- a/src/Service/MediaConvert/src/ValueObject/HlsRenditionGroupSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/HlsRenditionGroupSettings.php @@ -16,16 +16,22 @@ final class HlsRenditionGroupSettings { /** * Optional. Specify alternative group ID. + * + * @var string|null */ private $renditionGroupId; /** * Optional. Specify ISO 639-2 or ISO 639-3 code in the language property. + * + * @var LanguageCode::*|null */ private $renditionLanguageCode; /** * Optional. Specify media name. + * + * @var string|null */ private $renditionName; diff --git a/src/Service/MediaConvert/src/ValueObject/HlsSettings.php b/src/Service/MediaConvert/src/ValueObject/HlsSettings.php index 0a512f894..f76283b21 100644 --- a/src/Service/MediaConvert/src/ValueObject/HlsSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/HlsSettings.php @@ -15,6 +15,8 @@ final class HlsSettings { /** * Specifies the group to which the audio rendition belongs. + * + * @var string|null */ private $audioGroupId; @@ -23,12 +25,16 @@ final class HlsSettings * container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless * of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS * container. + * + * @var HlsAudioOnlyContainer::*|null */ private $audioOnlyContainer; /** * List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are * associated to the video, separate by ','. + * + * @var string|null */ private $audioRenditionSets; @@ -40,6 +46,8 @@ final class HlsSettings * rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with * DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play * back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO. + * + * @var HlsAudioTrackType::*|null */ private $audioTrackType; @@ -49,6 +57,8 @@ final class HlsSettings * EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this * parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple * documentation. + * + * @var HlsDescriptiveVideoServiceFlag::*|null */ private $descriptiveVideoServiceFlag; @@ -58,6 +68,8 @@ final class HlsSettings * that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular * child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value * Exclude (EXCLUDE). + * + * @var HlsIFrameOnlyManifest::*|null */ private $iframeOnlyManifest; @@ -65,6 +77,8 @@ final class HlsSettings * Use this setting to add an identifying string to the filename of each segment. The service adds this string between * the name modifier and segment index number. You can use format identifiers in the string. For more information, see * https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html. + * + * @var string|null */ private $segmentModifier; diff --git a/src/Service/MediaConvert/src/ValueObject/HopDestination.php b/src/Service/MediaConvert/src/ValueObject/HopDestination.php index 06e1d2a41..c3ecb9937 100644 --- a/src/Service/MediaConvert/src/ValueObject/HopDestination.php +++ b/src/Service/MediaConvert/src/ValueObject/HopDestination.php @@ -11,6 +11,8 @@ final class HopDestination /** * Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in * the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue. + * + * @var int|null */ private $priority; @@ -18,12 +20,16 @@ final class HopDestination * Optional unless the job is submitted on the default queue. When you set up a job to use queue hopping, you can * specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original * queue isn't the default queue and you don't specify the destination queue, the job will move to the default queue. + * + * @var string|null */ private $queue; /** * Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the * destination queue. Valid range is 1 to 4320 minutes, inclusive. + * + * @var int|null */ private $waitMinutes; diff --git a/src/Service/MediaConvert/src/ValueObject/Id3Insertion.php b/src/Service/MediaConvert/src/ValueObject/Id3Insertion.php index b7f9604fa..5eaecf780 100644 --- a/src/Service/MediaConvert/src/ValueObject/Id3Insertion.php +++ b/src/Service/MediaConvert/src/ValueObject/Id3Insertion.php @@ -11,11 +11,15 @@ final class Id3Insertion { /** * Use ID3 tag (Id3) to provide a fully formed ID3 tag in base64-encode format. + * + * @var string|null */ private $id3; /** * Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format. + * + * @var string|null */ private $timecode; diff --git a/src/Service/MediaConvert/src/ValueObject/ImageInserter.php b/src/Service/MediaConvert/src/ValueObject/ImageInserter.php index e5e0b858c..29a45d0a7 100644 --- a/src/Service/MediaConvert/src/ValueObject/ImageInserter.php +++ b/src/Service/MediaConvert/src/ValueObject/ImageInserter.php @@ -11,6 +11,8 @@ final class ImageInserter { /** * Specify the images that you want to overlay on your video. The images must be PNG or TGA files. + * + * @var InsertableImage[]|null */ private $insertableImages; @@ -19,6 +21,8 @@ final class ImageInserter * within HDR10 outputs. For 1,000 nit peak brightness displays, we recommend that you set SDR reference white level to * 203 (according to ITU-R BT.2408). Leave blank to use the default value of 100, or specify an integer from 100 to * 1000. + * + * @var int|null */ private $sdrReferenceWhiteLevel; diff --git a/src/Service/MediaConvert/src/ValueObject/ImscDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/ImscDestinationSettings.php index a071b2350..77e4144da 100644 --- a/src/Service/MediaConvert/src/ValueObject/ImscDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/ImscDestinationSettings.php @@ -25,6 +25,8 @@ final class ImscDestinationSettings * provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead * adds the following in the adaptation set for this track: ``. + * + * @var ImscAccessibilitySubs::*|null */ private $accessibility; @@ -32,6 +34,8 @@ final class ImscDestinationSettings * Keep this setting enabled to have MediaConvert use the font style and position information from the captions source * in the output. This option is available only when your input captions are IMSC, SMPTE-TT, or TTML. Disable this * setting for simplified output captions. + * + * @var ImscStylePassthrough::*|null */ private $stylePassthrough; diff --git a/src/Service/MediaConvert/src/ValueObject/Input.php b/src/Service/MediaConvert/src/ValueObject/Input.php index ad7ce6b47..e6ccb1c95 100644 --- a/src/Service/MediaConvert/src/ValueObject/Input.php +++ b/src/Service/MediaConvert/src/ValueObject/Input.php @@ -28,11 +28,15 @@ final class Input * the filter, you can optionally add texture or sharpening as an additional step. Jobs that use this feature incur * pro-tier pricing. To not apply advanced input filtering: Choose Disabled. Note that you can still apply basic * filtering with Deblock and Denoise. + * + * @var AdvancedInputFilter::*|null */ private $advancedInputFilter; /** * Optional settings for Advanced input filter when you set Advanced input filter to Enabled. + * + * @var AdvancedInputFilterSettings|null */ private $advancedInputFilterSettings; @@ -40,18 +44,24 @@ final class Input * Use audio selector groups to combine multiple sidecar audio inputs so that you can assign them to a single output * audio tab (AudioDescription). Note that, if you're working with embedded audio, it's simpler to assign multiple input * tracks into a single audio selector rather than use an audio selector group. + * + * @var array|null */ private $audioSelectorGroups; /** * Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your * outputs. You can use multiple Audio selectors per input. + * + * @var array|null */ private $audioSelectors; /** * Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to * 100 captions selectors per input. + * + * @var array|null */ private $captionSelectors; @@ -59,12 +69,16 @@ final class Input * Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If * you specify a value here, it will override any value that you specify in the output setting Cropping selection * (crop). + * + * @var Rectangle|null */ private $crop; /** * Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually * controllable for MPEG2 and uncompressed video inputs. + * + * @var InputDeblockFilter::*|null */ private $deblockFilter; @@ -72,12 +86,16 @@ final class Input * Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can * decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your * content. + * + * @var InputDecryptionSettings|null */ private $decryptionSettings; /** * Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, * H.264, H.265, and uncompressed video inputs. + * + * @var InputDenoiseFilter::*|null */ private $denoiseFilter; @@ -88,6 +106,8 @@ final class Input * global and frame level metadata, MediaConvert ignores the interleaved metadata and uses only the the metadata from * this external XML file. Note that your IAM service role must grant MediaConvert read permissions to this file. For * more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. + * + * @var string|null */ private $dolbyVisionMetadataXml; @@ -97,6 +117,8 @@ final class Input * is IMF, specify your input by providing the path to your CPL. For example, "s3://bucket/vf/cpl.xml". If the CPL is in * an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that * contain assets referenced by the CPL. + * + * @var string|null */ private $fileInput; @@ -104,6 +126,8 @@ final class Input * Specify whether to apply input filtering to improve the video quality of your input. To apply filtering depending on * your input type and quality: Choose Auto. To apply no filtering: Choose Disable. To apply filtering regardless of * your input type and quality: Choose Force. When you do, you must also specify a value for Filter strength. + * + * @var InputFilterEnable::*|null */ private $filterEnable; @@ -113,12 +137,16 @@ final class Input * apply filtering: Enter a value from 1 to 5, where 1 is the least amount of filtering and 5 is the most. The value * that you enter applies to the strength of the Deblock or Denoise filters, or to the strength of the Advanced input * filter. + * + * @var int|null */ private $filterStrength; /** * Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each * input individually. This setting is disabled by default. + * + * @var ImageInserter|null */ private $imageInserter; @@ -127,6 +155,8 @@ final class Input * outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you * provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, * the transcoding service creates the job outputs by stringing the clips together in the order you specify them. + * + * @var InputClipping[]|null */ private $inputClippings; @@ -136,6 +166,8 @@ final class Input * quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto (AUTO). * Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is * interlaced. Doing so creates horizontal interlacing artifacts. + * + * @var InputScanType::*|null */ private $inputScanType; @@ -145,6 +177,8 @@ final class Input * output setting Selection placement (position). If you specify a value here, this will override any AFD values in your * input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will * ignore anything that you specify for the setting Scaling Behavior (scalingBehavior). + * + * @var Rectangle|null */ private $position; @@ -152,12 +186,16 @@ final class Input * Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad * 4K is not currently supported. Default is the first program within the transport stream. If the program you specify * doesn't exist, the transcoding service will use this default. + * + * @var int|null */ private $programNumber; /** * Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data. + * + * @var InputPsiControl::*|null */ private $psiControl; @@ -166,6 +204,8 @@ final class Input * input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the * ASSETMAP.xml files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You don't need to specify the * IMP that contains your input CPL, because the service automatically detects it. + * + * @var string[]|null */ private $supplementalImps; @@ -177,6 +217,8 @@ final class Input * start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode * (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more * information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode. + * + * @var InputTimecodeSource::*|null */ private $timecodeSource; @@ -185,6 +227,8 @@ final class Input * set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start * (SPECIFIEDSTART). For more information about timecodes, see * https://docs.aws.amazon.com/console/mediaconvert/timecode. + * + * @var string|null */ private $timecodeStart; @@ -193,12 +237,16 @@ final class Input * not have a video input or if you want to add black video frames before, or after, other inputs. You can specify Video * generator, or you can specify an Input file, but you cannot specify both. For more information, see * https://docs.aws.amazon.com/mediaconvert/latest/ug/video-generator.html. + * + * @var InputVideoGenerator|null */ private $videoGenerator; /** * Input video selectors contain the video settings for the input. Each of your inputs can have up to one video * selector. + * + * @var VideoSelector|null */ private $videoSelector; diff --git a/src/Service/MediaConvert/src/ValueObject/InputClipping.php b/src/Service/MediaConvert/src/ValueObject/InputClipping.php index 336195b25..2611b6161 100644 --- a/src/Service/MediaConvert/src/ValueObject/InputClipping.php +++ b/src/Service/MediaConvert/src/ValueObject/InputClipping.php @@ -16,6 +16,8 @@ final class InputClipping * number. When choosing this value, take into account your setting for timecode source under input settings * (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip * to end six minutes into the video, use 01:06:00:00. + * + * @var string|null */ private $endTimecode; @@ -26,6 +28,8 @@ final class InputClipping * and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For * example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into * the video, use 01:05:00:00. + * + * @var string|null */ private $startTimecode; diff --git a/src/Service/MediaConvert/src/ValueObject/InputDecryptionSettings.php b/src/Service/MediaConvert/src/ValueObject/InputDecryptionSettings.php index bfbfc7164..dda542679 100644 --- a/src/Service/MediaConvert/src/ValueObject/InputDecryptionSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/InputDecryptionSettings.php @@ -14,6 +14,8 @@ final class InputDecryptionSettings { /** * Specify the encryption mode that you used to encrypt your input files. + * + * @var DecryptionMode::*|null */ private $decryptionMode; @@ -21,6 +23,8 @@ final class InputDecryptionSettings * Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your * encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. * The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits. + * + * @var string|null */ private $encryptedDecryptionKey; @@ -28,12 +32,16 @@ final class InputDecryptionSettings * Specify the initialization vector that you used when you encrypted your content before uploading it to Amazon S3. You * can use a 16-byte initialization vector with any encryption mode. Or, you can use a 12-byte initialization vector * with GCM or CTR. MediaConvert accepts only initialization vectors that are base64-encoded. + * + * @var string|null */ private $initializationVector; /** * Specify the AWS Region for AWS Key Management Service (KMS) that you used to encrypt your data key, if that Region is * different from the one you are using for AWS Elemental MediaConvert. + * + * @var string|null */ private $kmsKeyRegion; diff --git a/src/Service/MediaConvert/src/ValueObject/InputVideoGenerator.php b/src/Service/MediaConvert/src/ValueObject/InputVideoGenerator.php index c60b77a0a..d665da7d3 100644 --- a/src/Service/MediaConvert/src/ValueObject/InputVideoGenerator.php +++ b/src/Service/MediaConvert/src/ValueObject/InputVideoGenerator.php @@ -13,6 +13,8 @@ final class InputVideoGenerator /** * Specify an integer value for Black video duration from 50 to 86400000 to generate a black video input for that many * milliseconds. Required when you include Video generator. + * + * @var int|null */ private $duration; diff --git a/src/Service/MediaConvert/src/ValueObject/InsertableImage.php b/src/Service/MediaConvert/src/ValueObject/InsertableImage.php index 3d052da10..d3727a540 100644 --- a/src/Service/MediaConvert/src/ValueObject/InsertableImage.php +++ b/src/Service/MediaConvert/src/ValueObject/InsertableImage.php @@ -10,6 +10,8 @@ final class InsertableImage /** * Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time * but not fade-out time. + * + * @var int|null */ private $duration; @@ -17,6 +19,8 @@ final class InsertableImage * Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the * time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If * you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time. + * + * @var int|null */ private $fadeIn; @@ -24,6 +28,8 @@ final class InsertableImage * Specify the length of time, in milliseconds, between the end of the time that you have specified for the image * overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for * Fade-out, the image will disappear abruptly at the end of the inserted image duration. + * + * @var int|null */ private $fadeOut; @@ -31,42 +37,56 @@ final class InsertableImage * Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution * height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting * blank. + * + * @var int|null */ private $height; /** * Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA * file. + * + * @var string|null */ private $imageInserterInput; /** * Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any * image overlay that you specify. + * + * @var int|null */ private $imageX; /** * Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any * image overlay that you specify. + * + * @var int|null */ private $imageY; /** * Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with * lower values for Layer. + * + * @var int|null */ private $layer; /** * Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent * and 100 is fully opaque. Default is 50. + * + * @var int|null */ private $opacity; /** * Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF * or HH:MM:SS;FF) format. Remember to take into account your timecode source settings. + * + * @var string|null */ private $startTime; @@ -74,6 +94,8 @@ final class InsertableImage * Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution * width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting * blank. + * + * @var int|null */ private $width; diff --git a/src/Service/MediaConvert/src/ValueObject/Job.php b/src/Service/MediaConvert/src/ValueObject/Job.php index 0c3b435b0..0519e5a4d 100644 --- a/src/Service/MediaConvert/src/ValueObject/Job.php +++ b/src/Service/MediaConvert/src/ValueObject/Job.php @@ -18,6 +18,8 @@ final class Job { /** * Accelerated transcoding can significantly speed up jobs with long, visually complex content. + * + * @var AccelerationSettings|null */ private $accelerationSettings; @@ -30,17 +32,23 @@ final class Job * compatible with accelerated transcoding, the service either fails your job or runs it without accelerated * transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without * accelerated transcoding, AccelerationStatus is NOT_ACCELERATED. + * + * @var AccelerationStatus::*|null */ private $accelerationStatus; /** * An identifier for this resource that is unique within all of AWS. + * + * @var string|null */ private $arn; /** * The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any * billing report that you set up. + * + * @var BillingTagsSource::*|null */ private $billingTagsSource; @@ -49,36 +57,50 @@ final class Job * string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful * request, the API returns the job details of the original request instead. For more information see * https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html. + * + * @var string|null */ private $clientRequestToken; /** * The time, in Unix epoch format in seconds, when the job got created. + * + * @var \DateTimeImmutable|null */ private $createdAt; /** * A job's phase can be PROBING, TRANSCODING OR UPLOADING. + * + * @var JobPhase::*|null */ private $currentPhase; /** * Error code for the job. + * + * @var int|null */ private $errorCode; /** * Error message of Job. + * + * @var string|null */ private $errorMessage; /** * Optional list of hop destinations. + * + * @var HopDestination[]|null */ private $hopDestinations; /** * A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources. + * + * @var string|null */ private $id; @@ -89,26 +111,36 @@ final class Job * ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, * Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those * cases, jobPercentComplete returns a null value. + * + * @var int|null */ private $jobPercentComplete; /** * The job template that the job is created from, if it is created from a job template. + * + * @var string|null */ private $jobTemplate; /** * Provides messages from the service about jobs that you have already successfully submitted. + * + * @var JobMessages|null */ private $messages; /** * List of output group details. + * + * @var OutputGroupDetail[]|null */ private $outputGroupDetails; /** * Relative priority on the job. + * + * @var int|null */ private $priority; @@ -116,27 +148,37 @@ final class Job * When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default * queue. For more about queues, see the User Guide topic at * https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html. + * + * @var string|null */ private $queue; /** * The job's queue hopping history. + * + * @var QueueTransition[]|null */ private $queueTransitions; /** * The number of times that the service automatically attempted to process your job after encountering an error. + * + * @var int|null */ private $retryCount; /** * The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide * at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. + * + * @var string */ private $role; /** * JobSettings contains all the transcode settings for a job. + * + * @var JobSettings */ private $settings; @@ -144,11 +186,15 @@ final class Job * Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this * is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one * RTS in a reserved queue. This setting is disabled by default. + * + * @var SimulateReservedQueue::*|null */ private $simulateReservedQueue; /** * A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR. + * + * @var JobStatus::*|null */ private $status; @@ -156,22 +202,30 @@ final class Job * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, * between status updates. MediaConvert sends an update at this interval from the time the service begins processing * your job to the time it completes the transcode or encounters an error. + * + * @var StatusUpdateInterval::*|null */ private $statusUpdateInterval; /** * Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds. + * + * @var Timing|null */ private $timing; /** * User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. + * + * @var array|null */ private $userMetadata; /** * Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For * more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html. + * + * @var WarningGroup[]|null */ private $warnings; diff --git a/src/Service/MediaConvert/src/ValueObject/JobMessages.php b/src/Service/MediaConvert/src/ValueObject/JobMessages.php index 138573cc2..5113c41d5 100644 --- a/src/Service/MediaConvert/src/ValueObject/JobMessages.php +++ b/src/Service/MediaConvert/src/ValueObject/JobMessages.php @@ -9,11 +9,15 @@ final class JobMessages { /** * List of messages that are informational only and don't indicate a problem with your job. + * + * @var string[]|null */ private $info; /** * List of messages that warn about conditions that might cause your job not to run or to fail. + * + * @var string[]|null */ private $warning; diff --git a/src/Service/MediaConvert/src/ValueObject/JobSettings.php b/src/Service/MediaConvert/src/ValueObject/JobSettings.php index 96bdb4a31..f43a782db 100644 --- a/src/Service/MediaConvert/src/ValueObject/JobSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/JobSettings.php @@ -9,17 +9,23 @@ final class JobSettings { /** * When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. + * + * @var int|null */ private $adAvailOffset; /** * Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 * triggered ad avails. + * + * @var AvailBlanking|null */ private $availBlanking; /** * Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings. + * + * @var EsamSettings|null */ private $esam; @@ -27,12 +33,16 @@ final class JobSettings * If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does with * the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from the output. * For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory. + * + * @var ExtendedDataServices|null */ private $extendedDataServices; /** * Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These * inputs will be concantenated together to create the output. + * + * @var Input[]|null */ private $inputs; @@ -41,6 +51,8 @@ final class JobSettings * place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to * specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, * see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html. + * + * @var KantarWatermarkSettings|null */ private $kantarWatermark; @@ -48,6 +60,8 @@ final class JobSettings * Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all * output groups. For more information, see * https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html. + * + * @var MotionImageInserter|null */ private $motionImageInserter; @@ -56,6 +70,8 @@ final class JobSettings * When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs * in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your * JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting. + * + * @var NielsenConfiguration|null */ private $nielsenConfiguration; @@ -65,6 +81,8 @@ final class JobSettings * to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is * currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine * Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]. + * + * @var NielsenNonLinearWatermarkSettings|null */ private $nielsenNonLinearWatermark; @@ -75,18 +93,24 @@ final class JobSettings * value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, * DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings. + * + * @var OutputGroup[]|null */ private $outputGroups; /** * These settings control how the service handles timecodes throughout the job. These settings don't affect input * clipping. + * + * @var TimecodeConfig|null */ private $timecodeConfig; /** * Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want * to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). + * + * @var TimedMetadataInsertion|null */ private $timedMetadataInsertion; diff --git a/src/Service/MediaConvert/src/ValueObject/KantarWatermarkSettings.php b/src/Service/MediaConvert/src/ValueObject/KantarWatermarkSettings.php index cbfd3a153..5723555fd 100644 --- a/src/Service/MediaConvert/src/ValueObject/KantarWatermarkSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/KantarWatermarkSettings.php @@ -12,11 +12,15 @@ final class KantarWatermarkSettings { /** * Provide an audio channel name from your Kantar audio license. + * + * @var string|null */ private $channelName; /** * Specify a unique identifier for Kantar to use for this piece of content. + * + * @var string|null */ private $contentReference; @@ -27,22 +31,30 @@ final class KantarWatermarkSettings * For instructions on creating a secret, see * https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User * Guide. + * + * @var string|null */ private $credentialsSecretName; /** * Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. * When you don't specify an offset, Kantar defaults to zero. + * + * @var float|null */ private $fileOffset; /** * Provide your Kantar license ID number. You should get this number from Kantar. + * + * @var int|null */ private $kantarLicenseId; /** * Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar. + * + * @var string|null */ private $kantarServerUrl; @@ -50,6 +62,8 @@ final class KantarWatermarkSettings * Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you * don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide * access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. + * + * @var string|null */ private $logDestination; @@ -58,31 +72,43 @@ final class KantarWatermarkSettings * suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are * managed specifically for use with this feature by your Audience Measurement Operator. For more information about this * feature, contact Kantar technical support. + * + * @var string|null */ private $metadata3; /** * Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. + * + * @var string|null */ private $metadata4; /** * Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. + * + * @var string|null */ private $metadata5; /** * Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. + * + * @var string|null */ private $metadata6; /** * Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. + * + * @var string|null */ private $metadata7; /** * Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. + * + * @var string|null */ private $metadata8; diff --git a/src/Service/MediaConvert/src/ValueObject/M2tsScte35Esam.php b/src/Service/MediaConvert/src/ValueObject/M2tsScte35Esam.php index c4a75210f..febe8ce4c 100644 --- a/src/Service/MediaConvert/src/ValueObject/M2tsScte35Esam.php +++ b/src/Service/MediaConvert/src/ValueObject/M2tsScte35Esam.php @@ -11,6 +11,8 @@ final class M2tsScte35Esam { /** * Packet Identifier (PID) of the SCTE-35 stream in the transport stream generated by ESAM. + * + * @var int|null */ private $scte35EsamPid; diff --git a/src/Service/MediaConvert/src/ValueObject/M2tsSettings.php b/src/Service/MediaConvert/src/ValueObject/M2tsSettings.php index d7b0a43d7..590e5e3f5 100644 --- a/src/Service/MediaConvert/src/ValueObject/M2tsSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/M2tsSettings.php @@ -32,6 +32,8 @@ final class M2tsSettings { /** * Selects between the DVB and ATSC buffer models for Dolby Digital audio. + * + * @var M2tsAudioBufferModel::*|null */ private $audioBufferModel; @@ -45,23 +47,31 @@ final class M2tsSettings * applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, * MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies * between audio and video duration will depend on your output audio codec. + * + * @var M2tsAudioDuration::*|null */ private $audioDuration; /** * The number of audio frames to insert for each PES packet. + * + * @var int|null */ private $audioFramesPerPes; /** * Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple * PIDs as a JSON array. Default is the range 482-492. + * + * @var int[]|null */ private $audioPids; /** * Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically * determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000. + * + * @var int|null */ private $bitrate; @@ -69,6 +79,8 @@ final class M2tsSettings * Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set * to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without * interruptions. + * + * @var M2tsBufferModel::*|null */ private $bufferModel; @@ -76,6 +88,8 @@ final class M2tsSettings * If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values * greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS * values). Keep the default value (AUTO) to allow all PTS values. + * + * @var M2tsDataPtsControl::*|null */ private $dataPtsControl; @@ -83,6 +97,8 @@ final class M2tsSettings * Use these settings to insert a DVB Network Information Table (NIT) in the transport stream of this output. When you * work directly in your JSON job specification, include this object only when your job has a transport stream output * and the container settings contain the object M2tsSettings. + * + * @var DvbNitSettings|null */ private $dvbNitSettings; @@ -90,12 +106,16 @@ final class M2tsSettings * Use these settings to insert a DVB Service Description Table (SDT) in the transport stream of this output. When you * work directly in your JSON job specification, include this object only when your job has a transport stream output * and the container settings contain the object M2tsSettings. + * + * @var DvbSdtSettings|null */ private $dvbSdtSettings; /** * Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON * array. Default is the range 460-479. + * + * @var int[]|null */ private $dvbSubPids; @@ -103,11 +123,15 @@ final class M2tsSettings * Use these settings to insert a DVB Time and Date Table (TDT) in the transport stream of this output. When you work * directly in your JSON job specification, include this object only when your job has a transport stream output and the * container settings contain the object M2tsSettings. + * + * @var DvbTdtSettings|null */ private $dvbTdtSettings; /** * Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499. + * + * @var int|null */ private $dvbTeletextPid; @@ -116,6 +140,8 @@ final class M2tsSettings * these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to * VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is * selected (segmentationMarkers is EBP or EBP_LEGACY). + * + * @var M2tsEbpAudioInterval::*|null */ private $ebpAudioInterval; @@ -123,22 +149,30 @@ final class M2tsSettings * Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID * and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or * EBP_LEGACY). + * + * @var M2tsEbpPlacement::*|null */ private $ebpPlacement; /** * Controls whether to include the ES Rate field in the PES header. + * + * @var M2tsEsRateInPes::*|null */ private $esRateInPes; /** * Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your * video EBP markers. To correct this problem, set this value to Force (FORCE). + * + * @var M2tsForceTsVideoEbpOrder::*|null */ private $forceTsVideoEbpOrder; /** * The length, in seconds, of each fragment. Only used with EBP markers. + * + * @var float|null */ private $fragmentTime; @@ -146,12 +180,16 @@ final class M2tsSettings * To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads * KLV metadata present in your input and passes it through to the output transport stream. To exclude this KLV * metadata: Set KLV metadata insertion to None or leave blank. + * + * @var M2tsKlvMetadata::*|null */ private $klvMetadata; /** * Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport * stream. + * + * @var int|null */ private $maxPcrInterval; @@ -160,50 +198,68 @@ final class M2tsSettings * looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP * is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the * system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. + * + * @var int|null */ private $minEbpInterval; /** * If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag * will be inserted in the output. + * + * @var M2tsNielsenId3::*|null */ private $nielsenId3; /** * Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream * encryption system requires periodic null packets. + * + * @var float|null */ private $nullPacketBitrate; /** * The number of milliseconds between instances of this table in the output transport stream. + * + * @var int|null */ private $patInterval; /** * When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream * (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream. + * + * @var M2tsPcrControl::*|null */ private $pcrControl; /** * Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a * value, the service will use the value for Video PID (VideoPid). + * + * @var int|null */ private $pcrPid; /** * Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream. + * + * @var int|null */ private $pmtInterval; /** * Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480. + * + * @var int|null */ private $pmtPid; /** * Specify the packet identifier (PID) of the private metadata stream. Default is 503. + * + * @var int|null */ private $privateMetadataPid; @@ -211,23 +267,31 @@ final class M2tsSettings * Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. * Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for * organizing data. + * + * @var int|null */ private $programNumber; /** * When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate * setting acts as the maximum bitrate, but the output will not be padded up to that bitrate. + * + * @var M2tsRateMode::*|null */ private $rateMode; /** * Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion * points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml). + * + * @var M2tsScte35Esam|null */ private $scte35Esam; /** * Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream. + * + * @var int|null */ private $scte35Pid; @@ -236,6 +300,8 @@ final class M2tsSettings * your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For * SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting * Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam). + * + * @var M2tsScte35Source::*|null */ private $scte35Source; @@ -245,6 +311,8 @@ final class M2tsSettings * psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the * adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point * information to the adaptation field using a legacy proprietary format. + * + * @var M2tsSegmentationMarkers::*|null */ private $segmentationMarkers; @@ -257,27 +325,37 @@ final class M2tsSettings * will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, * all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight * exception to this rule. + * + * @var M2tsSegmentationStyle::*|null */ private $segmentationStyle; /** * Specify the length, in seconds, of each segment. Required unless markers is set to _none_. + * + * @var float|null */ private $segmentationTime; /** * Packet Identifier (PID) of the ID3 metadata stream in the transport stream. + * + * @var int|null */ private $timedMetadataPid; /** * Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and * program map tables are parts of MPEG-2 transport stream containers, used for organizing data. + * + * @var int|null */ private $transportStreamId; /** * Specify the packet identifier (PID) of the elementary video stream in the transport stream. + * + * @var int|null */ private $videoPid; diff --git a/src/Service/MediaConvert/src/ValueObject/M3u8Settings.php b/src/Service/MediaConvert/src/ValueObject/M3u8Settings.php index 8290317e8..7e53b999b 100644 --- a/src/Service/MediaConvert/src/ValueObject/M3u8Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/M3u8Settings.php @@ -26,17 +26,23 @@ final class M3u8Settings * applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, * MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies * between audio and video duration will depend on your output audio codec. + * + * @var M3u8AudioDuration::*|null */ private $audioDuration; /** * The number of audio frames to insert for each PES packet. + * + * @var int|null */ private $audioFramesPerPes; /** * Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and * can be entered in ranges and/or by comma separation. + * + * @var int[]|null */ private $audioPids; @@ -44,60 +50,82 @@ final class M3u8Settings * If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values * greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS * values). Keep the default value (AUTO) to allow all PTS values. + * + * @var M3u8DataPtsControl::*|null */ private $dataPtsControl; /** * Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport * stream. + * + * @var int|null */ private $maxPcrInterval; /** * If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag * will be inserted in the output. + * + * @var M3u8NielsenId3::*|null */ private $nielsenId3; /** * The number of milliseconds between instances of this table in the output transport stream. + * + * @var int|null */ private $patInterval; /** * When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream * (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. + * + * @var M3u8PcrControl::*|null */ private $pcrControl; /** * Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the * encoder will assign the same value as the Video PID. + * + * @var int|null */ private $pcrPid; /** * The number of milliseconds between instances of this table in the output transport stream. + * + * @var int|null */ private $pmtInterval; /** * Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. + * + * @var int|null */ private $pmtPid; /** * Packet Identifier (PID) of the private metadata stream in the transport stream. + * + * @var int|null */ private $privateMetadataPid; /** * The value of the program number field in the Program Map Table. + * + * @var int|null */ private $programNumber; /** * Packet Identifier (PID) of the SCTE-35 stream in the transport stream. + * + * @var int|null */ private $scte35Pid; @@ -107,6 +135,8 @@ final class M3u8Settings * SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose * Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also * provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). + * + * @var M3u8Scte35Source::*|null */ private $scte35Source; @@ -115,21 +145,29 @@ final class M3u8Settings * ID3 metadata from the following features: ID3 timestamp period (timedMetadataId3Period), and Custom ID3 metadata * inserter (timedMetadataInsertion). To exclude this ID3 metadata in this output: set ID3 metadata to None (NONE) or * leave blank. + * + * @var TimedMetadata::*|null */ private $timedMetadata; /** * Packet Identifier (PID) of the ID3 metadata stream in the transport stream. + * + * @var int|null */ private $timedMetadataPid; /** * The value of the transport stream ID field in the Program Map Table. + * + * @var int|null */ private $transportStreamId; /** * Packet Identifier (PID) of the elementary video stream in the transport stream. + * + * @var int|null */ private $videoPid; diff --git a/src/Service/MediaConvert/src/ValueObject/MinBottomRenditionSize.php b/src/Service/MediaConvert/src/ValueObject/MinBottomRenditionSize.php index 09f3ec84f..1dfda2860 100644 --- a/src/Service/MediaConvert/src/ValueObject/MinBottomRenditionSize.php +++ b/src/Service/MediaConvert/src/ValueObject/MinBottomRenditionSize.php @@ -13,11 +13,15 @@ final class MinBottomRenditionSize { /** * Use Height to define the video resolution height, in pixels, for this rule. + * + * @var int|null */ private $height; /** * Use Width to define the video resolution width, in pixels, for this rule. + * + * @var int|null */ private $width; diff --git a/src/Service/MediaConvert/src/ValueObject/MinTopRenditionSize.php b/src/Service/MediaConvert/src/ValueObject/MinTopRenditionSize.php index 7277fb18c..bb96085b6 100644 --- a/src/Service/MediaConvert/src/ValueObject/MinTopRenditionSize.php +++ b/src/Service/MediaConvert/src/ValueObject/MinTopRenditionSize.php @@ -13,11 +13,15 @@ final class MinTopRenditionSize { /** * Use Height to define the video resolution height, in pixels, for this rule. + * + * @var int|null */ private $height; /** * Use Width to define the video resolution width, in pixels, for this rule. + * + * @var int|null */ private $width; diff --git a/src/Service/MediaConvert/src/ValueObject/MotionImageInserter.php b/src/Service/MediaConvert/src/ValueObject/MotionImageInserter.php index 5a7579e5e..a8393e19c 100644 --- a/src/Service/MediaConvert/src/ValueObject/MotionImageInserter.php +++ b/src/Service/MediaConvert/src/ValueObject/MotionImageInserter.php @@ -19,6 +19,8 @@ final class MotionImageInserter * as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay * duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame * rate doesn't need to match the frame rate of the underlying video. + * + * @var MotionImageInsertionFramerate|null */ private $framerate; @@ -30,12 +32,16 @@ final class MotionImageInserter * initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, * there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is * overlay_00.png, there can be 100 images in the sequence. + * + * @var string|null */ private $input; /** * Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or * a series of .png files. + * + * @var MotionImageInsertionMode::*|null */ private $insertionMode; @@ -44,11 +50,15 @@ final class MotionImageInserter * upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of * the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with * any video scaling. + * + * @var MotionImageInsertionOffset|null */ private $offset; /** * Specify whether your motion graphic overlay repeats on a loop or plays only once. + * + * @var MotionImagePlayback::*|null */ private $playback; @@ -61,6 +71,8 @@ final class MotionImageInserter * https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode * configuration settings in your JSON job settings specification at settings>timecodeConfig>source and * settings>inputs>timecodeSource. + * + * @var string|null */ private $startTime; diff --git a/src/Service/MediaConvert/src/ValueObject/MotionImageInsertionFramerate.php b/src/Service/MediaConvert/src/ValueObject/MotionImageInsertionFramerate.php index ab4c87f59..e923a65bd 100644 --- a/src/Service/MediaConvert/src/ValueObject/MotionImageInsertionFramerate.php +++ b/src/Service/MediaConvert/src/ValueObject/MotionImageInsertionFramerate.php @@ -12,12 +12,16 @@ final class MotionImageInsertionFramerate /** * The bottom of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set * this value to 1. + * + * @var int|null */ private $framerateDenominator; /** * The top of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this * value to 24. + * + * @var int|null */ private $framerateNumerator; diff --git a/src/Service/MediaConvert/src/ValueObject/MotionImageInsertionOffset.php b/src/Service/MediaConvert/src/ValueObject/MotionImageInsertionOffset.php index 2e2d0023d..b8601ce20 100644 --- a/src/Service/MediaConvert/src/ValueObject/MotionImageInsertionOffset.php +++ b/src/Service/MediaConvert/src/ValueObject/MotionImageInsertionOffset.php @@ -9,11 +9,15 @@ final class MotionImageInsertionOffset { /** * Set the distance, in pixels, between the overlay and the left edge of the video frame. + * + * @var int|null */ private $imageX; /** * Set the distance, in pixels, between the overlay and the top edge of the video frame. + * + * @var int|null */ private $imageY; diff --git a/src/Service/MediaConvert/src/ValueObject/MovSettings.php b/src/Service/MediaConvert/src/ValueObject/MovSettings.php index ab5947da1..b38f094e8 100644 --- a/src/Service/MediaConvert/src/ValueObject/MovSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/MovSettings.php @@ -16,6 +16,8 @@ final class MovSettings { /** * When enabled, include 'clap' atom if appropriate for the video output settings. + * + * @var MovClapAtom::*|null */ private $clapAtom; @@ -23,6 +25,8 @@ final class MovSettings * When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) * box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 * amendment 1. This improves compatibility with Apple players and tools. + * + * @var MovCslgAtom::*|null */ private $cslgAtom; @@ -30,6 +34,8 @@ final class MovSettings * When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases * compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when * the video codec is MPEG2. + * + * @var MovMpeg2FourCCControl::*|null */ private $mpeg2FourccControl; @@ -37,11 +43,15 @@ final class MovSettings * Unless you need Omneon compatibility: Keep the default value, None. To make this output compatible with Omneon: * Choose Omneon. When you do, MediaConvert increases the length of the 'elst' edit list atom. Note that this might * cause file rejections when a recipient of the output file doesn't expect this extra padding. + * + * @var MovPaddingControl::*|null */ private $paddingControl; /** * Always keep the default value (SELF_CONTAINED) for this setting. + * + * @var MovReference::*|null */ private $reference; diff --git a/src/Service/MediaConvert/src/ValueObject/Mp2Settings.php b/src/Service/MediaConvert/src/ValueObject/Mp2Settings.php index d880cc50a..11a178fd2 100644 --- a/src/Service/MediaConvert/src/ValueObject/Mp2Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Mp2Settings.php @@ -9,17 +9,23 @@ final class Mp2Settings { /** * Specify the average bitrate in bits per second. + * + * @var int|null */ private $bitrate; /** * Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you * 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2. + * + * @var int|null */ private $channels; /** * Sample rate in hz. + * + * @var int|null */ private $sampleRate; diff --git a/src/Service/MediaConvert/src/ValueObject/Mp3Settings.php b/src/Service/MediaConvert/src/ValueObject/Mp3Settings.php index a3518780e..0e4aa0ac3 100644 --- a/src/Service/MediaConvert/src/ValueObject/Mp3Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Mp3Settings.php @@ -12,28 +12,38 @@ final class Mp3Settings { /** * Specify the average bitrate in bits per second. + * + * @var int|null */ private $bitrate; /** * Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output channel; * choosing Stereo gives you 2. In the API, valid values are 1 and 2. + * + * @var int|null */ private $channels; /** * Specify whether the service encodes this MP3 audio output with a constant bitrate (CBR) or a variable bitrate (VBR). + * + * @var Mp3RateControlMode::*|null */ private $rateControlMode; /** * Sample rate in hz. + * + * @var int|null */ private $sampleRate; /** * Required when you set Bitrate control mode (rateControlMode) to VBR. Specify the audio quality of this MP3 output * from 0 (highest quality) to 9 (lowest quality). + * + * @var int|null */ private $vbrQuality; diff --git a/src/Service/MediaConvert/src/ValueObject/Mp4Settings.php b/src/Service/MediaConvert/src/ValueObject/Mp4Settings.php index 6e654322d..23774c507 100644 --- a/src/Service/MediaConvert/src/ValueObject/Mp4Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Mp4Settings.php @@ -25,6 +25,8 @@ final class Mp4Settings * applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, * MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies * between audio and video duration will depend on your output audio codec. + * + * @var CmfcAudioDuration::*|null */ private $audioDuration; @@ -32,6 +34,8 @@ final class Mp4Settings * When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) * box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 * amendment 1. This improves compatibility with Apple players and tools. + * + * @var Mp4CslgAtom::*|null */ private $cslgAtom; @@ -40,22 +44,30 @@ final class Mp4Settings * of 1 to set your CTTS box version to 1 and make your output compliant with the specification. When you specify a * value of 1, you must also set CSLG atom (cslgAtom) to the value INCLUDE. Keep the default value 0 to set your CTTS * box version to 0. This can provide backward compatibility for some players and packagers. + * + * @var int|null */ private $cttsVersion; /** * Inserts a free-space box immediately after the moov box. + * + * @var Mp4FreeSpaceBox::*|null */ private $freeSpaceBox; /** * If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for * progressive downloading. Otherwise it is placed normally at the end. + * + * @var Mp4MoovPlacement::*|null */ private $moovPlacement; /** * Overrides the "Major Brand" field in the output file. Usually not necessary to specify. + * + * @var string|null */ private $mp4MajorBrand; diff --git a/src/Service/MediaConvert/src/ValueObject/MpdSettings.php b/src/Service/MediaConvert/src/ValueObject/MpdSettings.php index a351fef3e..6858474f6 100644 --- a/src/Service/MediaConvert/src/ValueObject/MpdSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/MpdSettings.php @@ -24,6 +24,8 @@ final class MpdSettings * play embedded 608 captions. Keep the default value, Exclude (EXCLUDE), to leave these elements out. When you enable * this setting, this is the markup that MediaConvert includes in your manifest: ``. + * + * @var MpdAccessibilityCaptionHints::*|null */ private $accessibilityCaptionHints; @@ -37,6 +39,8 @@ final class MpdSettings * applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, * MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies * between audio and video duration will depend on your output audio codec. + * + * @var MpdAudioDuration::*|null */ private $audioDuration; @@ -45,6 +49,8 @@ final class MpdSettings * in a separate output from your audio and video. Choose Raw (RAW) for captions in a single XML file in a raw * container. Choose Fragmented MPEG-4 (FRAGMENTED_MP4) for captions in XML format contained within fragmented MP4 * files. This set of fragmented MP4 files is separate from your video and audio fragmented MP4 files. + * + * @var MpdCaptionContainerType::*|null */ private $captionContainerType; @@ -52,6 +58,8 @@ final class MpdSettings * To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads * KLV metadata present in your input and writes each instance to a separate event message box in the output, according * to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank. + * + * @var MpdKlvMetadata::*|null */ private $klvMetadata; @@ -62,6 +70,8 @@ final class MpdSettings * "urn:scte:scte35:2013:bin". To leave these elements out of your output MPD manifest, set Manifest metadata signaling * to Disabled. To enable Manifest metadata signaling, you must also set SCTE-35 source to Passthrough, ESAM SCTE-35 to * insert, or ID3 metadata (TimedMetadata) to Passthrough. + * + * @var MpdManifestMetadataSignaling::*|null */ private $manifestMetadataSignaling; @@ -69,6 +79,8 @@ final class MpdSettings * Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output * at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML * (sccXml). + * + * @var MpdScte35Esam::*|null */ private $scte35Esam; @@ -76,6 +88,8 @@ final class MpdSettings * Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you * want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want * those SCTE-35 markers in this output. + * + * @var MpdScte35Source::*|null */ private $scte35Source; @@ -84,6 +98,8 @@ final class MpdSettings * ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 * metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or * leave blank. + * + * @var MpdTimedMetadata::*|null */ private $timedMetadata; @@ -92,6 +108,8 @@ final class MpdSettings * For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. * Leave blank to use the default value Version 0. * When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Passthrough. + * + * @var MpdTimedMetadataBoxVersion::*|null */ private $timedMetadataBoxVersion; @@ -100,6 +118,8 @@ final class MpdSettings * information, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. Leave blank to use the default value: * https://aomedia.org/emsg/ID3 When you specify a value for ID3 metadata scheme ID URI, you must also set ID3 metadata * (timedMetadata) to Passthrough. + * + * @var string|null */ private $timedMetadataSchemeIdUri; @@ -107,6 +127,8 @@ final class MpdSettings * Specify the event message box (eMSG) value for ID3 timed metadata in your output. For more information, see ISO/IEC * 23009-1:2022 section 5.10.3.3.4 Semantics. When you specify a value for ID3 Metadata Value, you must also set ID3 * metadata (timedMetadata) to Passthrough. + * + * @var string|null */ private $timedMetadataValue; diff --git a/src/Service/MediaConvert/src/ValueObject/Mpeg2Settings.php b/src/Service/MediaConvert/src/ValueObject/Mpeg2Settings.php index 663cf0edd..f8f68474e 100644 --- a/src/Service/MediaConvert/src/ValueObject/Mpeg2Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Mpeg2Settings.php @@ -32,22 +32,30 @@ final class Mpeg2Settings * Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to * the following settings: Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive * quantization (temporalAdaptiveQuantization). + * + * @var Mpeg2AdaptiveQuantization::*|null */ private $adaptiveQuantization; /** * Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be * unique when rounded down to the nearest multiple of 1000. + * + * @var int|null */ private $bitrate; /** * Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output. + * + * @var Mpeg2CodecLevel::*|null */ private $codecLevel; /** * Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output. + * + * @var Mpeg2CodecProfile::*|null */ private $codecProfile; @@ -56,6 +64,8 @@ final class Mpeg2Settings * B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for * low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames * between reference frames (numberBFramesBetweenReferenceFrames). + * + * @var Mpeg2DynamicSubGop::*|null */ private $dynamicSubGop; @@ -68,6 +78,8 @@ final class Mpeg2Settings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var Mpeg2FramerateControl::*|null */ private $framerateControl; @@ -80,6 +92,8 @@ final class Mpeg2Settings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var Mpeg2FramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -88,6 +102,8 @@ final class Mpeg2Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -96,6 +112,8 @@ final class Mpeg2Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; @@ -104,6 +122,8 @@ final class Mpeg2Settings * GOPs and then require a closed GOP, set this value to 5. When you create a streaming output, we recommend that you * keep the default value, 1, so that players starting mid-stream receive an IDR frame as quickly as possible. Don't set * this value to 0; that would break output segmenting. + * + * @var int|null */ private $gopClosedCadence; @@ -111,12 +131,16 @@ final class Mpeg2Settings * Specify the interval between keyframes, in seconds or frames, for this output. Default: 12 Related settings: When you * specify the GOP size in seconds, set GOP mode control (GopSizeUnits) to Specified, seconds (SECONDS). The default * value for GOP mode control (GopSizeUnits) is Frames (FRAMES). + * + * @var float|null */ private $gopSize; /** * Specify the units for GOP size (GopSize). If you don't specify a value here, by default the encoder measures GOP size * in frames. + * + * @var Mpeg2GopSizeUnits::*|null */ private $gopSizeUnits; @@ -124,16 +148,22 @@ final class Mpeg2Settings * If your downstream systems have strict buffer requirements: Specify the minimum percentage of the HRD buffer that's * available at the end of each encoded video segment. For the best video quality: Set to 0 or leave blank to * automatically determine the final buffer fill percentage. + * + * @var int|null */ private $hrdBufferFinalFillPercentage; /** * Percentage of the buffer that should initially be filled (HRD buffer model). + * + * @var int|null */ private $hrdBufferInitialFillPercentage; /** * Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. + * + * @var int|null */ private $hrdBufferSize; @@ -146,17 +176,23 @@ final class Mpeg2Settings * Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the * same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field * first, depending on which of the Follow options you choose. + * + * @var Mpeg2InterlaceMode::*|null */ private $interlaceMode; /** * Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you * choose the value auto, the service will automatically select the precision based on the per-frame compression ratio. + * + * @var Mpeg2IntraDcPrecision::*|null */ private $intraDcPrecision; /** * Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. + * + * @var int|null */ private $maxBitrate; @@ -169,12 +205,16 @@ final class Mpeg2Settings * cadence-driven I-frame. In this way, one GOP is shrunk slightly and one GOP is stretched slightly. When the * cadence-driven I-frames are farther from the scene-change I-frame than the value you set, then the encoder leaves all * I-frames in place and the GOPs surrounding the scene change are smaller than the usual cadence GOPs. + * + * @var int|null */ private $minIinterval; /** * Specify the number of B-frames that MediaConvert puts between reference frames in this output. Valid values are whole * numbers from 0 through 7. When you don't specify a value, MediaConvert defaults to 2. + * + * @var int|null */ private $numberBframesBetweenReferenceFrames; @@ -184,6 +224,8 @@ final class Mpeg2Settings * PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job * specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the * parNumerator and parDenominator settings. + * + * @var Mpeg2ParControl::*|null */ private $parControl; @@ -192,6 +234,8 @@ final class Mpeg2Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parDenominator is 33. + * + * @var int|null */ private $parDenominator; @@ -200,17 +244,23 @@ final class Mpeg2Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parNumerator is 40. + * + * @var int|null */ private $parNumerator; /** * Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output * video quality. The default behavior is faster, lower quality, single-pass encoding. + * + * @var Mpeg2QualityTuningLevel::*|null */ private $qualityTuningLevel; /** * Use Rate control mode (Mpeg2RateControlMode) to specify whether the bitrate is variable (vbr) or constant (cbr). + * + * @var Mpeg2RateControlMode::*|null */ private $rateControlMode; @@ -224,12 +274,16 @@ final class Mpeg2Settings * basic interlacing. Required settings: To use optimized interlacing, you must set Telecine (telecine) to None (NONE) * or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode * (interlaceMode) to a value other than Progressive (PROGRESSIVE). + * + * @var Mpeg2ScanTypeConversionMode::*|null */ private $scanTypeConversionMode; /** * Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video * quality and is enabled by default. + * + * @var Mpeg2SceneChangeDetect::*|null */ private $sceneChangeDetect; @@ -239,6 +293,8 @@ final class Mpeg2Settings * keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. * Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to * (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. + * + * @var Mpeg2SlowPal::*|null */ private $slowPal; @@ -249,6 +305,8 @@ final class Mpeg2Settings * setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, to use the AWS * Elemental default matrices. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to * 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video. + * + * @var int|null */ private $softness; @@ -263,12 +321,16 @@ final class Mpeg2Settings * setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization * (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it * to Low. For content with a wider variety of textures, set it to High or Higher. + * + * @var Mpeg2SpatialAdaptiveQuantization::*|null */ private $spatialAdaptiveQuantization; /** * Specify whether this output's video uses the D10 syntax. Keep the default value to not use the syntax. Related * settings: When you choose D10 (D_10) for your MXF profile (profile), you must also set this value to D10 (D_10). + * + * @var Mpeg2Syntax::*|null */ private $syntax; @@ -279,6 +341,8 @@ final class Mpeg2Settings * player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does * a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother * picture. + * + * @var Mpeg2Telecine::*|null */ private $telecine; @@ -292,6 +356,8 @@ final class Mpeg2Settings * objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: * When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization * (adaptiveQuantization). + * + * @var Mpeg2TemporalAdaptiveQuantization::*|null */ private $temporalAdaptiveQuantization; diff --git a/src/Service/MediaConvert/src/ValueObject/MsSmoothAdditionalManifest.php b/src/Service/MediaConvert/src/ValueObject/MsSmoothAdditionalManifest.php index e82907186..f0dacd63c 100644 --- a/src/Service/MediaConvert/src/ValueObject/MsSmoothAdditionalManifest.php +++ b/src/Service/MediaConvert/src/ValueObject/MsSmoothAdditionalManifest.php @@ -13,11 +13,15 @@ final class MsSmoothAdditionalManifest * of the other main manifests in the output group. For example, say that the default main manifest for your Microsoft * Smooth group is film-name.ismv. If you enter "-no-premium" for this setting, then the file name the service generates * for this top-level manifest is film-name-no-premium.ismv. + * + * @var string|null */ private $manifestNameModifier; /** * Specify the outputs that you want this additional top-level manifest to reference. + * + * @var string[]|null */ private $selectedOutputs; diff --git a/src/Service/MediaConvert/src/ValueObject/MsSmoothEncryptionSettings.php b/src/Service/MediaConvert/src/ValueObject/MsSmoothEncryptionSettings.php index 7d6bfe9c2..13bdfd93a 100644 --- a/src/Service/MediaConvert/src/ValueObject/MsSmoothEncryptionSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/MsSmoothEncryptionSettings.php @@ -10,6 +10,8 @@ final class MsSmoothEncryptionSettings /** * If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a * SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead. + * + * @var SpekeKeyProvider|null */ private $spekeKeyProvider; diff --git a/src/Service/MediaConvert/src/ValueObject/MsSmoothGroupSettings.php b/src/Service/MediaConvert/src/ValueObject/MsSmoothGroupSettings.php index 398f181bc..b4d4a1e54 100644 --- a/src/Service/MediaConvert/src/ValueObject/MsSmoothGroupSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/MsSmoothGroupSettings.php @@ -19,12 +19,16 @@ final class MsSmoothGroupSettings * By default, the service creates one .ism Microsoft Smooth Streaming manifest for each Microsoft Smooth Streaming * output group in your job. This default manifest references every output in the output group. To create additional * manifests that reference a subset of the outputs in the output group, specify a list of them here. + * + * @var MsSmoothAdditionalManifest[]|null */ private $additionalManifests; /** * COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a Microsoft Smooth output group into a * single audio stream. + * + * @var MsSmoothAudioDeduplication::*|null */ private $audioDeduplication; @@ -32,16 +36,22 @@ final class MsSmoothGroupSettings * Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts * format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the * input file. If your job has multiple inputs, the service uses the filename of the first input file. + * + * @var string|null */ private $destination; /** * Settings associated with the destination. Will vary based on the type of destination. + * + * @var DestinationSettings|null */ private $destinationSettings; /** * If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider. + * + * @var MsSmoothEncryptionSettings|null */ private $encryption; @@ -50,6 +60,8 @@ final class MsSmoothGroupSettings * exact length that you specify with the setting Fragment length (FragmentLength). This might result in extra I-frames. * Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP * boundary. + * + * @var int|null */ private $fragmentLength; @@ -58,12 +70,16 @@ final class MsSmoothGroupSettings * exact length that you specify with the setting Fragment length (FragmentLength). This might result in extra I-frames. * Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP * boundary. + * + * @var MsSmoothFragmentLengthControl::*|null */ private $fragmentLengthControl; /** * Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. * Valid options are utf8 and utf16. + * + * @var MsSmoothManifestEncoding::*|null */ private $manifestEncoding; diff --git a/src/Service/MediaConvert/src/ValueObject/MxfSettings.php b/src/Service/MediaConvert/src/ValueObject/MxfSettings.php index be012a186..bec60dfc9 100644 --- a/src/Service/MediaConvert/src/ValueObject/MxfSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/MxfSettings.php @@ -18,6 +18,8 @@ final class MxfSettings * Regardless of which option you choose, the AFD values remain in the video stream. Related settings: To set up your * output to include or exclude AFD values, see AfdSignaling, under VideoDescription. On the console, find AFD signaling * under the output's video encoding settings. + * + * @var MxfAfdSignaling::*|null */ private $afdSignaling; @@ -27,11 +29,15 @@ final class MxfSettings * https://docs.aws.amazon.com/mediaconvert/latest/ug/codecs-supported-with-each-mxf-profile.html. For more information * about the automatic selection behavior, see * https://docs.aws.amazon.com/mediaconvert/latest/ug/default-automatic-selection-of-mxf-profiles.html. + * + * @var MxfProfile::*|null */ private $profile; /** * Specify the XAVC profile settings for MXF outputs when you set your MXF profile to XAVC. + * + * @var MxfXavcProfileSettings|null */ private $xavcProfileSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/MxfXavcProfileSettings.php b/src/Service/MediaConvert/src/ValueObject/MxfXavcProfileSettings.php index 258223f98..39065d41d 100644 --- a/src/Service/MediaConvert/src/ValueObject/MxfXavcProfileSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/MxfXavcProfileSettings.php @@ -15,6 +15,8 @@ final class MxfXavcProfileSettings * Drop frames for compliance (DROP_FRAMES_FOR_COMPLIANCE). To include all frames from your input in this output, keep * the default setting, Allow any duration (ALLOW_ANY_DURATION). The number of frames that MediaConvert excludes when * you set this to Drop frames for compliance depends on the output frame rate and duration. + * + * @var MxfXavcDurationMode::*|null */ private $durationMode; @@ -24,6 +26,8 @@ final class MxfXavcProfileSettings * service reserves for ancillary data, such as teletext captions. The default value for this setting is 1492 bytes per * frame. This should be sufficient to prevent overflow unless you have multiple pages of teletext captions data. If you * have a large amount of teletext data, specify a larger number. + * + * @var int|null */ private $maxAncDataSize; diff --git a/src/Service/MediaConvert/src/ValueObject/NexGuardFileMarkerSettings.php b/src/Service/MediaConvert/src/ValueObject/NexGuardFileMarkerSettings.php index 85be50ef3..105649650 100644 --- a/src/Service/MediaConvert/src/ValueObject/NexGuardFileMarkerSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/NexGuardFileMarkerSettings.php @@ -15,6 +15,8 @@ final class NexGuardFileMarkerSettings * Use the base64 license string that Nagra provides you. Enter it directly in your JSON job specification or in the * console. Required when you include Nagra NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your * job. + * + * @var string|null */ private $license; @@ -27,18 +29,24 @@ final class NexGuardFileMarkerSettings * IDs. For OTT Streaming, create two adaptive bitrate (ABR) stacks for each asset. Do this by setting up two output * groups. For one output group, set the value of Payload ID (payload) to 0 in every output. For the other output group, * set Payload ID (payload) to 1 in every output. + * + * @var int|null */ private $payload; /** * Enter one of the watermarking preset strings that Nagra provides you. Required when you include Nagra NexGuard File * Marker watermarking (NexGuardWatermarkingSettings) in your job. + * + * @var string|null */ private $preset; /** * Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value * here, the Nagra NexGuard library uses its default value. + * + * @var WatermarkingStrength::*|null */ private $strength; diff --git a/src/Service/MediaConvert/src/ValueObject/NielsenConfiguration.php b/src/Service/MediaConvert/src/ValueObject/NielsenConfiguration.php index 7ccb5b9a5..2200c4036 100644 --- a/src/Service/MediaConvert/src/ValueObject/NielsenConfiguration.php +++ b/src/Service/MediaConvert/src/ValueObject/NielsenConfiguration.php @@ -13,11 +13,15 @@ final class NielsenConfiguration /** * Nielsen has discontinued the use of breakout code functionality. If you must include this property, set the value to * zero. + * + * @var int|null */ private $breakoutCode; /** * Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by Neilsen. + * + * @var string|null */ private $distributorId; diff --git a/src/Service/MediaConvert/src/ValueObject/NielsenNonLinearWatermarkSettings.php b/src/Service/MediaConvert/src/ValueObject/NielsenNonLinearWatermarkSettings.php index ae6c80dc7..697aeb9f2 100644 --- a/src/Service/MediaConvert/src/ValueObject/NielsenNonLinearWatermarkSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/NielsenNonLinearWatermarkSettings.php @@ -21,6 +21,8 @@ final class NielsenNonLinearWatermarkSettings * you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for * the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide * values for both of these settings. + * + * @var NielsenActiveWatermarkProcessType::*|null */ private $activeWatermarkProcess; @@ -29,17 +31,23 @@ final class NielsenNonLinearWatermarkSettings * provide an ADI file, store it in Amazon S3 and provide a URL to it here. The URL should be in the following format: * S3://bucket/path/ADI-file. For more information about the metadata .zip file, see the setting Metadata destination * (metadataDestination). + * + * @var string|null */ private $adiFilename; /** * Use the asset ID that you provide to Nielsen to uniquely identify this asset. Required for all Nielsen non-linear * watermarking. + * + * @var string|null */ private $assetId; /** * Use the asset name that you provide to Nielsen for this asset. Required for all Nielsen non-linear watermarking. + * + * @var string|null */ private $assetName; @@ -47,11 +55,15 @@ final class NielsenNonLinearWatermarkSettings * Use the CSID that Nielsen provides to you. This CBET source ID should be unique to your Nielsen account but common to * all of your output assets that have CBET watermarking. Required when you choose a value for the setting Watermark * types (ActiveWatermarkProcess) that includes CBET. + * + * @var string|null */ private $cbetSourceId; /** * Optional. If this asset uses an episode ID with Nielsen, provide it here. + * + * @var string|null */ private $episodeId; @@ -61,6 +73,8 @@ final class NielsenNonLinearWatermarkSettings * include an ADI file in this .zip file, use the setting ADI file (adiFilename) to specify it. MediaConvert delivers * the Nielsen metadata .zip files only to your metadata destination Amazon S3 bucket. It doesn't deliver the .zip files * to Nielsen. You are responsible for delivering the metadata .zip files to Nielsen. + * + * @var string|null */ private $metadataDestination; @@ -68,6 +82,8 @@ final class NielsenNonLinearWatermarkSettings * Use the SID that Nielsen provides to you. This source ID should be unique to your Nielsen account but common to all * of your output assets. Required for all Nielsen non-linear watermarking. This ID should be unique to your Nielsen * account but common to all of your output assets. Required for all Nielsen non-linear watermarking. + * + * @var int|null */ private $sourceId; @@ -75,6 +91,8 @@ final class NielsenNonLinearWatermarkSettings * Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value * to Watermarked (WATERMARKED), the service fails the job. Nielsen requires that you add non-linear watermarking to * only clean content that doesn't already have non-linear Nielsen watermarks. + * + * @var NielsenSourceWatermarkStatusType::*|null */ private $sourceWatermarkStatus; @@ -83,6 +101,8 @@ final class NielsenNonLinearWatermarkSettings * Nielsen non-linear watermarking. MediaConvert can't connect directly to a TIC server. Instead, you must use API * Gateway to provide a RESTful interface between MediaConvert and a TIC server that you deploy in your AWS account. For * more information on deploying a TIC server in your AWS account and the required API Gateway, contact Nielsen support. + * + * @var string|null */ private $ticServerUrl; @@ -90,6 +110,8 @@ final class NielsenNonLinearWatermarkSettings * To create assets that have the same TIC values in each audio track, keep the default value Share TICs * (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs * (RESERVE_UNIQUE_TICS_PER_TRACK). + * + * @var NielsenUniqueTicPerAudioTrackType::*|null */ private $uniqueTicPerAudioTrack; diff --git a/src/Service/MediaConvert/src/ValueObject/NoiseReducer.php b/src/Service/MediaConvert/src/ValueObject/NoiseReducer.php index 18518d2b9..923c044bb 100644 --- a/src/Service/MediaConvert/src/ValueObject/NoiseReducer.php +++ b/src/Service/MediaConvert/src/ValueObject/NoiseReducer.php @@ -19,21 +19,29 @@ final class NoiseReducer * noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max * noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video * quality for complex motion. + * + * @var NoiseReducerFilter::*|null */ private $filter; /** * Settings for a noise reducer filter. + * + * @var NoiseReducerFilterSettings|null */ private $filterSettings; /** * Noise reducer filter settings for spatial filter. + * + * @var NoiseReducerSpatialFilterSettings|null */ private $spatialFilterSettings; /** * Noise reducer filter settings for temporal filter. + * + * @var NoiseReducerTemporalFilterSettings|null */ private $temporalFilterSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/NoiseReducerFilterSettings.php b/src/Service/MediaConvert/src/ValueObject/NoiseReducerFilterSettings.php index d4eb4ee0e..b9d071f5e 100644 --- a/src/Service/MediaConvert/src/ValueObject/NoiseReducerFilterSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/NoiseReducerFilterSettings.php @@ -9,6 +9,8 @@ final class NoiseReducerFilterSettings { /** * Relative strength of noise reducing filter. Higher values produce stronger filtering. + * + * @var int|null */ private $strength; diff --git a/src/Service/MediaConvert/src/ValueObject/NoiseReducerSpatialFilterSettings.php b/src/Service/MediaConvert/src/ValueObject/NoiseReducerSpatialFilterSettings.php index b02ea944c..a399e96fb 100644 --- a/src/Service/MediaConvert/src/ValueObject/NoiseReducerSpatialFilterSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/NoiseReducerSpatialFilterSettings.php @@ -10,16 +10,22 @@ final class NoiseReducerSpatialFilterSettings /** * Specify strength of post noise reduction sharpening filter, with 0 disabling the filter and 3 enabling it at maximum * strength. + * + * @var int|null */ private $postFilterSharpenStrength; /** * The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value. + * + * @var int|null */ private $speed; /** * Relative strength of noise reducing filter. Higher values produce stronger filtering. + * + * @var int|null */ private $strength; diff --git a/src/Service/MediaConvert/src/ValueObject/NoiseReducerTemporalFilterSettings.php b/src/Service/MediaConvert/src/ValueObject/NoiseReducerTemporalFilterSettings.php index b9ad0001d..4cb84002c 100644 --- a/src/Service/MediaConvert/src/ValueObject/NoiseReducerTemporalFilterSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/NoiseReducerTemporalFilterSettings.php @@ -14,6 +14,8 @@ final class NoiseReducerTemporalFilterSettings /** * Use Aggressive mode for content that has complex motion. Higher values produce stronger temporal filtering. This * filters highly complex scenes more aggressively and creates better VQ for low bitrate outputs. + * + * @var int|null */ private $aggressiveMode; @@ -25,6 +27,8 @@ final class NoiseReducerTemporalFilterSettings * on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much * sharpening is applied using Post temporal sharpening strength (postTemporalSharpeningStrength). Set Post temporal * sharpening to Disabled (DISABLED) to not apply sharpening. + * + * @var NoiseFilterPostTemporalSharpening::*|null */ private $postTemporalSharpening; @@ -32,12 +36,16 @@ final class NoiseReducerTemporalFilterSettings * Use Post temporal sharpening strength (postTemporalSharpeningStrength) to define the amount of sharpening the * transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), Medium (MEDIUM), or High * (HIGH) to indicate the amount of sharpening. + * + * @var NoiseFilterPostTemporalSharpeningStrength::*|null */ private $postTemporalSharpeningStrength; /** * The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high * setting improves transcode time at the cost of bit rate. + * + * @var int|null */ private $speed; @@ -46,6 +54,8 @@ final class NoiseReducerTemporalFilterSettings * recommend the following value ranges, depending on the result that you want: * 0-2 for complexity reduction with * minimal sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for a high level of complexity * reduction. + * + * @var int|null */ private $strength; diff --git a/src/Service/MediaConvert/src/ValueObject/OpusSettings.php b/src/Service/MediaConvert/src/ValueObject/OpusSettings.php index 336b3774c..192be2748 100644 --- a/src/Service/MediaConvert/src/ValueObject/OpusSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/OpusSettings.php @@ -10,17 +10,23 @@ final class OpusSettings /** * Optional. Specify the average bitrate in bits per second. Valid values are multiples of 8000, from 32000 through * 192000. The default value is 96000, which we recommend for quality and bandwidth. + * + * @var int|null */ private $bitrate; /** * Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output channel; * choosing Stereo gives you 2. In the API, valid values are 1 and 2. + * + * @var int|null */ private $channels; /** * Optional. Sample rate in hz. Valid values are 16000, 24000, and 48000. The default value is 48000. + * + * @var int|null */ private $sampleRate; diff --git a/src/Service/MediaConvert/src/ValueObject/Output.php b/src/Service/MediaConvert/src/ValueObject/Output.php index 3e6f73db3..0d8ec9c63 100644 --- a/src/Service/MediaConvert/src/ValueObject/Output.php +++ b/src/Service/MediaConvert/src/ValueObject/Output.php @@ -12,17 +12,23 @@ final class Output /** * (AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of * (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings. + * + * @var AudioDescription[]|null */ private $audioDescriptions; /** * (CaptionDescriptions) contains groups of captions settings. For each output that has captions, include one instance * of (CaptionDescriptions). (CaptionDescriptions) can contain multiple groups of captions settings. + * + * @var CaptionDescription[]|null */ private $captionDescriptions; /** * Container specific settings. + * + * @var ContainerSettings|null */ private $containerSettings; @@ -31,6 +37,8 @@ final class Output * value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will * use codec extensions (e.g. AAC, H265, H265, AC3). + * + * @var string|null */ private $extension; @@ -40,23 +48,31 @@ final class Output * modifier (NameModifier) is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use * the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the * output group. + * + * @var string|null */ private $nameModifier; /** * Specific settings for this type of output. + * + * @var OutputSettings|null */ private $outputSettings; /** * Use Preset (Preset) to specify a preset for your transcoding settings. Provide the system or custom preset name. You * can specify either Preset (Preset) or Container settings (ContainerSettings), but not both. + * + * @var string|null */ private $preset; /** * VideoDescription contains a group of video encoding settings. The specific video settings depend on the video codec * that you choose for the property codec. Include one instance of VideoDescription per output. + * + * @var VideoDescription|null */ private $videoDescription; diff --git a/src/Service/MediaConvert/src/ValueObject/OutputChannelMapping.php b/src/Service/MediaConvert/src/ValueObject/OutputChannelMapping.php index 849ec0fa0..3a67c1a6e 100644 --- a/src/Service/MediaConvert/src/ValueObject/OutputChannelMapping.php +++ b/src/Service/MediaConvert/src/ValueObject/OutputChannelMapping.php @@ -9,12 +9,16 @@ final class OutputChannelMapping { /** * Use this setting to specify your remix values when they are integers, such as -10, 0, or 4. + * + * @var int[]|null */ private $inputChannels; /** * Use this setting to specify your remix values when they have a decimal component, such as -10.312, 0.08, or 4.9. * MediaConvert rounds your remixing values to the nearest thousandth. + * + * @var float[]|null */ private $inputChannelsFineTune; diff --git a/src/Service/MediaConvert/src/ValueObject/OutputDetail.php b/src/Service/MediaConvert/src/ValueObject/OutputDetail.php index ffe4690ad..101cfa41d 100644 --- a/src/Service/MediaConvert/src/ValueObject/OutputDetail.php +++ b/src/Service/MediaConvert/src/ValueObject/OutputDetail.php @@ -9,11 +9,15 @@ final class OutputDetail { /** * Duration in milliseconds. + * + * @var int|null */ private $durationInMs; /** * Contains details about the output's video stream. + * + * @var VideoDetail|null */ private $videoDetails; diff --git a/src/Service/MediaConvert/src/ValueObject/OutputGroup.php b/src/Service/MediaConvert/src/ValueObject/OutputGroup.php index 98d5fc734..3517a7741 100644 --- a/src/Service/MediaConvert/src/ValueObject/OutputGroup.php +++ b/src/Service/MediaConvert/src/ValueObject/OutputGroup.php @@ -10,6 +10,8 @@ final class OutputGroup /** * Use automated encoding to have MediaConvert choose your encoding settings for you, based on characteristics of your * input video. + * + * @var AutomatedEncodingSettings|null */ private $automatedEncodingSettings; @@ -17,21 +19,29 @@ final class OutputGroup * Use Custom Group Name (CustomName) to specify a name for the output group. This value is displayed on the console and * can make your job settings JSON more human-readable. It does not affect your outputs. Use up to twelve characters * that are either letters, numbers, spaces, or underscores. + * + * @var string|null */ private $customName; /** * Name of the output group. + * + * @var string|null */ private $name; /** * Output Group settings, including type. + * + * @var OutputGroupSettings|null */ private $outputGroupSettings; /** * This object holds groups of encoding settings, one group of settings per output. + * + * @var Output[]|null */ private $outputs; diff --git a/src/Service/MediaConvert/src/ValueObject/OutputGroupDetail.php b/src/Service/MediaConvert/src/ValueObject/OutputGroupDetail.php index adf16fc85..08a05dcaa 100644 --- a/src/Service/MediaConvert/src/ValueObject/OutputGroupDetail.php +++ b/src/Service/MediaConvert/src/ValueObject/OutputGroupDetail.php @@ -9,6 +9,8 @@ final class OutputGroupDetail { /** * Details about the output. + * + * @var OutputDetail[]|null */ private $outputDetails; diff --git a/src/Service/MediaConvert/src/ValueObject/OutputGroupSettings.php b/src/Service/MediaConvert/src/ValueObject/OutputGroupSettings.php index 7d2c1ccd1..e2386adda 100644 --- a/src/Service/MediaConvert/src/ValueObject/OutputGroupSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/OutputGroupSettings.php @@ -15,6 +15,8 @@ final class OutputGroupSettings * https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job * specification, include this object and any required children when you set Type, under OutputGroupSettings, to * CMAF_GROUP_SETTINGS. + * + * @var CmafGroupSettings|null */ private $cmafGroupSettings; @@ -23,6 +25,8 @@ final class OutputGroupSettings * https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job * specification, include this object and any required children when you set Type, under OutputGroupSettings, to * DASH_ISO_GROUP_SETTINGS. + * + * @var DashIsoGroupSettings|null */ private $dashIsoGroupSettings; @@ -30,6 +34,8 @@ final class OutputGroupSettings * Settings related to your File output group. MediaConvert uses this group of settings to generate a single standalone * file, rather than a streaming package. When you work directly in your JSON job specification, include this object and * any required children when you set Type, under OutputGroupSettings, to FILE_GROUP_SETTINGS. + * + * @var FileGroupSettings|null */ private $fileGroupSettings; @@ -38,6 +44,8 @@ final class OutputGroupSettings * https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job * specification, include this object and any required children when you set Type, under OutputGroupSettings, to * HLS_GROUP_SETTINGS. + * + * @var HlsGroupSettings|null */ private $hlsGroupSettings; @@ -46,11 +54,15 @@ final class OutputGroupSettings * https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job * specification, include this object and any required children when you set Type, under OutputGroupSettings, to * MS_SMOOTH_GROUP_SETTINGS. + * + * @var MsSmoothGroupSettings|null */ private $msSmoothGroupSettings; /** * Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF). + * + * @var OutputGroupType::*|null */ private $type; diff --git a/src/Service/MediaConvert/src/ValueObject/OutputSettings.php b/src/Service/MediaConvert/src/ValueObject/OutputSettings.php index f2a51c022..9050e97ef 100644 --- a/src/Service/MediaConvert/src/ValueObject/OutputSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/OutputSettings.php @@ -9,6 +9,8 @@ final class OutputSettings { /** * Settings for HLS output groups. + * + * @var HlsSettings|null */ private $hlsSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/PartnerWatermarking.php b/src/Service/MediaConvert/src/ValueObject/PartnerWatermarking.php index 4d6bbdd91..9f3841d9e 100644 --- a/src/Service/MediaConvert/src/ValueObject/PartnerWatermarking.php +++ b/src/Service/MediaConvert/src/ValueObject/PartnerWatermarking.php @@ -11,6 +11,8 @@ final class PartnerWatermarking /** * For forensic video watermarking, MediaConvert supports Nagra NexGuard File Marker watermarking. MediaConvert supports * both PreRelease Content (NGPR/G2) and OTT Streaming workflows. + * + * @var NexGuardFileMarkerSettings|null */ private $nexguardFileMarkerSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/ProresSettings.php b/src/Service/MediaConvert/src/ValueObject/ProresSettings.php index 2b2259937..092a781db 100644 --- a/src/Service/MediaConvert/src/ValueObject/ProresSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/ProresSettings.php @@ -28,11 +28,15 @@ final class ProresSettings * sampling to Preserve 4:4:4 sampling, you must disable all video preprocessors except for Nexguard file marker * (PartnerWatermarking). When you set Chroma sampling to Preserve 4:4:4 sampling and use framerate conversion, you must * set Frame rate conversion algorithm (FramerateConversionAlgorithm) to Drop duplicate (DUPLICATE_DROP). + * + * @var ProresChromaSampling::*|null */ private $chromaSampling; /** * Use Profile (ProResCodecProfile) to specify the type of Apple ProRes codec to use for this output. + * + * @var ProresCodecProfile::*|null */ private $codecProfile; @@ -45,6 +49,8 @@ final class ProresSettings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var ProresFramerateControl::*|null */ private $framerateControl; @@ -57,6 +63,8 @@ final class ProresSettings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var ProresFramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -65,6 +73,8 @@ final class ProresSettings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -73,6 +83,8 @@ final class ProresSettings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; @@ -85,6 +97,8 @@ final class ProresSettings * Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the * same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field * first, depending on which of the Follow options you choose. + * + * @var ProresInterlaceMode::*|null */ private $interlaceMode; @@ -94,6 +108,8 @@ final class ProresSettings * PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job * specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the * parNumerator and parDenominator settings. + * + * @var ProresParControl::*|null */ private $parControl; @@ -102,6 +118,8 @@ final class ProresSettings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parDenominator is 33. + * + * @var int|null */ private $parDenominator; @@ -110,6 +128,8 @@ final class ProresSettings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parNumerator is 40. + * + * @var int|null */ private $parNumerator; @@ -123,6 +143,8 @@ final class ProresSettings * basic interlacing. Required settings: To use optimized interlacing, you must set Telecine (telecine) to None (NONE) * or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode * (interlaceMode) to a value other than Progressive (PROGRESSIVE). + * + * @var ProresScanTypeConversionMode::*|null */ private $scanTypeConversionMode; @@ -132,6 +154,8 @@ final class ProresSettings * keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. * Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to * (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. + * + * @var ProresSlowPal::*|null */ private $slowPal; @@ -140,6 +164,8 @@ final class ProresSettings * interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default * value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field * polarity to create a smoother picture. + * + * @var ProresTelecine::*|null */ private $telecine; diff --git a/src/Service/MediaConvert/src/ValueObject/QueueTransition.php b/src/Service/MediaConvert/src/ValueObject/QueueTransition.php index 89cc639db..7ff05b0dc 100644 --- a/src/Service/MediaConvert/src/ValueObject/QueueTransition.php +++ b/src/Service/MediaConvert/src/ValueObject/QueueTransition.php @@ -10,16 +10,22 @@ final class QueueTransition { /** * The queue that the job was on after the transition. + * + * @var string|null */ private $destinationQueue; /** * The queue that the job was on before the transition. + * + * @var string|null */ private $sourceQueue; /** * The time, in Unix epoch format, that the job moved from the source queue to the destination queue. + * + * @var \DateTimeImmutable|null */ private $timestamp; diff --git a/src/Service/MediaConvert/src/ValueObject/Rectangle.php b/src/Service/MediaConvert/src/ValueObject/Rectangle.php index 57a0c84d1..b8c99aa02 100644 --- a/src/Service/MediaConvert/src/ValueObject/Rectangle.php +++ b/src/Service/MediaConvert/src/ValueObject/Rectangle.php @@ -9,21 +9,29 @@ final class Rectangle { /** * Height of rectangle in pixels. Specify only even numbers. + * + * @var int|null */ private $height; /** * Width of rectangle in pixels. Specify only even numbers. + * + * @var int|null */ private $width; /** * The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers. + * + * @var int|null */ private $x; /** * The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers. + * + * @var int|null */ private $y; diff --git a/src/Service/MediaConvert/src/ValueObject/RemixSettings.php b/src/Service/MediaConvert/src/ValueObject/RemixSettings.php index ac35207e0..b5a9dda5d 100644 --- a/src/Service/MediaConvert/src/ValueObject/RemixSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/RemixSettings.php @@ -17,6 +17,8 @@ final class RemixSettings * Valid values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the * output channel (no attenuation or amplification). Use InputChannels or InputChannelsFineTune to specify your remix * values. Don't use both. + * + * @var ChannelMapping|null */ private $channelMapping; @@ -25,6 +27,8 @@ final class RemixSettings * combine or split the data in these channels, so the number of channels in your final output might be different. If * you are doing both input channel mapping and output channel mapping, the number of output channels in your input * mapping must be the same as the number of input channels in your output mapping. + * + * @var int|null */ private $channelsIn; @@ -32,6 +36,8 @@ final class RemixSettings * Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers * to 64.) If you are doing both input channel mapping and output channel mapping, the number of output channels in your * input mapping must be the same as the number of input channels in your output mapping. + * + * @var int|null */ private $channelsOut; diff --git a/src/Service/MediaConvert/src/ValueObject/S3DestinationAccessControl.php b/src/Service/MediaConvert/src/ValueObject/S3DestinationAccessControl.php index 3d9fabfb1..169c5d58e 100644 --- a/src/Service/MediaConvert/src/ValueObject/S3DestinationAccessControl.php +++ b/src/Service/MediaConvert/src/ValueObject/S3DestinationAccessControl.php @@ -13,6 +13,8 @@ final class S3DestinationAccessControl { /** * Choose an Amazon S3 canned ACL for MediaConvert to apply to this output. + * + * @var S3ObjectCannedAcl::*|null */ private $cannedAcl; diff --git a/src/Service/MediaConvert/src/ValueObject/S3DestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/S3DestinationSettings.php index bf77a71ac..01c8837f4 100644 --- a/src/Service/MediaConvert/src/ValueObject/S3DestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/S3DestinationSettings.php @@ -10,11 +10,15 @@ final class S3DestinationSettings /** * Optional. Have MediaConvert automatically apply Amazon S3 access control for the outputs in this output group. When * you don't use this setting, S3 automatically applies the default access control list PRIVATE. + * + * @var S3DestinationAccessControl|null */ private $accessControl; /** * Settings for how your job outputs are encrypted as they are uploaded to Amazon S3. + * + * @var S3EncryptionSettings|null */ private $encryption; diff --git a/src/Service/MediaConvert/src/ValueObject/S3EncryptionSettings.php b/src/Service/MediaConvert/src/ValueObject/S3EncryptionSettings.php index 0120c6aa7..61cb0f646 100644 --- a/src/Service/MediaConvert/src/ValueObject/S3EncryptionSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/S3EncryptionSettings.php @@ -19,6 +19,8 @@ final class S3EncryptionSettings * key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, * customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN * (kmsKeyArn). + * + * @var S3ServerSideEncryptionType::*|null */ private $encryptionType; @@ -28,6 +30,8 @@ final class S3EncryptionSettings * base64-encoded UTF-8 string holding JSON which represents a string-string map. To use this setting, you must also set * Server-side encryption (S3ServerSideEncryptionType) to AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). For more information * about encryption context, see: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context. + * + * @var string|null */ private $kmsEncryptionContext; @@ -36,6 +40,8 @@ final class S3EncryptionSettings * encrypt your output content. Enter the Amazon Resource Name (ARN) of the CMK. To use this setting, you must also set * Server-side encryption (S3ServerSideEncryptionType) to AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). If you set Server-side * encryption to AWS KMS but don't specify a CMK here, AWS uses the AWS managed CMK associated with Amazon S3. + * + * @var string|null */ private $kmsKeyArn; diff --git a/src/Service/MediaConvert/src/ValueObject/SccDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/SccDestinationSettings.php index 520214b40..0ea2123ae 100644 --- a/src/Service/MediaConvert/src/ValueObject/SccDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/SccDestinationSettings.php @@ -19,6 +19,8 @@ final class SccDestinationSettings * Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose * 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and drop_frame_timecode=true; * otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME). + * + * @var SccDestinationFramerate::*|null */ private $framerate; diff --git a/src/Service/MediaConvert/src/ValueObject/SpekeKeyProvider.php b/src/Service/MediaConvert/src/ValueObject/SpekeKeyProvider.php index 2c823cc87..680b4b9e4 100644 --- a/src/Service/MediaConvert/src/ValueObject/SpekeKeyProvider.php +++ b/src/Service/MediaConvert/src/ValueObject/SpekeKeyProvider.php @@ -11,11 +11,15 @@ final class SpekeKeyProvider /** * If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with * a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here. + * + * @var string|null */ private $certificateArn; /** * Specify the resource ID that your SPEKE-compliant key provider uses to identify this content. + * + * @var string|null */ private $resourceId; @@ -23,12 +27,16 @@ final class SpekeKeyProvider * Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other * group types support one system id. See * https://dashif.org/identifiers/content_protection/ for more details. + * + * @var string[]|null */ private $systemIds; /** * Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your * content. + * + * @var string|null */ private $url; diff --git a/src/Service/MediaConvert/src/ValueObject/SpekeKeyProviderCmaf.php b/src/Service/MediaConvert/src/ValueObject/SpekeKeyProviderCmaf.php index b9a18d69f..1f8523127 100644 --- a/src/Service/MediaConvert/src/ValueObject/SpekeKeyProviderCmaf.php +++ b/src/Service/MediaConvert/src/ValueObject/SpekeKeyProviderCmaf.php @@ -11,6 +11,8 @@ final class SpekeKeyProviderCmaf /** * If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with * a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here. + * + * @var string|null */ private $certificateArn; @@ -18,6 +20,8 @@ final class SpekeKeyProviderCmaf * Specify the DRM system IDs that you want signaled in the DASH manifest that MediaConvert creates as part of this CMAF * package. The DASH manifest can currently signal up to three system IDs. For more information, see * https://dashif.org/identifiers/content_protection/. + * + * @var string[]|null */ private $dashSignaledSystemIds; @@ -25,17 +29,23 @@ final class SpekeKeyProviderCmaf * Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF * package. The HLS manifest can currently signal only one system ID. For more information, see * https://dashif.org/identifiers/content_protection/. + * + * @var string[]|null */ private $hlsSignaledSystemIds; /** * Specify the resource ID that your SPEKE-compliant key provider uses to identify this content. + * + * @var string|null */ private $resourceId; /** * Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your * content. + * + * @var string|null */ private $url; diff --git a/src/Service/MediaConvert/src/ValueObject/SrtDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/SrtDestinationSettings.php index cbecd7535..119cc3d05 100644 --- a/src/Service/MediaConvert/src/ValueObject/SrtDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/SrtDestinationSettings.php @@ -18,6 +18,8 @@ final class SrtDestinationSettings * your input captions. MediaConvert uses default settings for any missing style and position information in your input * captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your * input captions and use simplified output captions. + * + * @var SrtStylePassthrough::*|null */ private $stylePassthrough; diff --git a/src/Service/MediaConvert/src/ValueObject/StaticKeyProvider.php b/src/Service/MediaConvert/src/ValueObject/StaticKeyProvider.php index 0462c4f9b..0641ed4a5 100644 --- a/src/Service/MediaConvert/src/ValueObject/StaticKeyProvider.php +++ b/src/Service/MediaConvert/src/ValueObject/StaticKeyProvider.php @@ -10,22 +10,30 @@ final class StaticKeyProvider /** * Relates to DRM implementation. Sets the value of the KEYFORMAT attribute. Must be 'identity' or a reverse DNS string. * May be omitted to indicate an implicit value of 'identity'. + * + * @var string|null */ private $keyFormat; /** * Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version * values (1/2/3). + * + * @var string|null */ private $keyFormatVersions; /** * Relates to DRM implementation. Use a 32-character hexidecimal string to specify Key Value (StaticKeyValue). + * + * @var string|null */ private $staticKeyValue; /** * Relates to DRM implementation. The location of the license server used for protecting content. + * + * @var string|null */ private $url; diff --git a/src/Service/MediaConvert/src/ValueObject/TeletextDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/TeletextDestinationSettings.php index a742b872d..4fe793268 100644 --- a/src/Service/MediaConvert/src/ValueObject/TeletextDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/TeletextDestinationSettings.php @@ -17,6 +17,8 @@ final class TeletextDestinationSettings * Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a * three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of * Teletext data, do not use this field. + * + * @var string|null */ private $pageNumber; @@ -24,6 +26,8 @@ final class TeletextDestinationSettings * Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to * the default value Subtitle (PAGE_TYPE_SUBTITLE). If you pass through the entire set of Teletext data, don't use this * field. When you pass through a set of Teletext pages, your output has the same page types as your input. + * + * @var list|null */ private $pageTypes; diff --git a/src/Service/MediaConvert/src/ValueObject/TeletextSourceSettings.php b/src/Service/MediaConvert/src/ValueObject/TeletextSourceSettings.php index 900614f5e..675e22fd2 100644 --- a/src/Service/MediaConvert/src/ValueObject/TeletextSourceSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/TeletextSourceSettings.php @@ -10,6 +10,8 @@ final class TeletextSourceSettings /** * Use Page Number (PageNumber) to specify the three-digit hexadecimal page number that will be used for Teletext * captions. Do not use this setting if you are passing through teletext from the input source to output. + * + * @var string|null */ private $pageNumber; diff --git a/src/Service/MediaConvert/src/ValueObject/TimecodeBurnin.php b/src/Service/MediaConvert/src/ValueObject/TimecodeBurnin.php index c8ded5fdc..01dddaa96 100644 --- a/src/Service/MediaConvert/src/ValueObject/TimecodeBurnin.php +++ b/src/Service/MediaConvert/src/ValueObject/TimecodeBurnin.php @@ -12,12 +12,16 @@ final class TimecodeBurnin { /** * Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48. + * + * @var int|null */ private $fontSize; /** * Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in timecode * on output video. + * + * @var TimecodeBurninPosition::*|null */ private $position; @@ -26,6 +30,8 @@ final class TimecodeBurnin * result in the timecode "EZ-00:00:00:00". Provide either the characters themselves or the ASCII code equivalents. The * supported range of characters is 0x20 through 0x7e. This includes letters, numbers, and all special characters * represented on a standard English keyboard. + * + * @var string|null */ private $prefix; diff --git a/src/Service/MediaConvert/src/ValueObject/TimecodeConfig.php b/src/Service/MediaConvert/src/ValueObject/TimecodeConfig.php index 2a2544729..04d146e8b 100644 --- a/src/Service/MediaConvert/src/ValueObject/TimecodeConfig.php +++ b/src/Service/MediaConvert/src/ValueObject/TimecodeConfig.php @@ -20,6 +20,8 @@ final class TimecodeConfig * (Start) are used calculate output timecode. * If Source (TimecodeSource) is set to Start at 0 (ZEROBASED) the first * frame is 00:00:00:00. * If Source (TimecodeSource) is set to Embedded (EMBEDDED), the first frame is the timecode * value on the first input frame of the input. + * + * @var string|null */ private $anchor; @@ -31,12 +33,16 @@ final class TimecodeConfig * source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the * initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value * other than zero. You use Start timecode (Start) to provide this value. + * + * @var TimecodeSource::*|null */ private $source; /** * Only use when you set Source (TimecodeSource) to Specified start (SPECIFIEDSTART). Use Start timecode (Start) to * specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). + * + * @var string|null */ private $start; @@ -46,6 +52,8 @@ final class TimecodeConfig * "yyyy-mm-dd". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the * output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year * later, set Timestamp offset (TimestampOffset) to 2003-1-25. + * + * @var string|null */ private $timestampOffset; diff --git a/src/Service/MediaConvert/src/ValueObject/TimedMetadataInsertion.php b/src/Service/MediaConvert/src/ValueObject/TimedMetadataInsertion.php index ee1834b73..aeeb910ca 100644 --- a/src/Service/MediaConvert/src/ValueObject/TimedMetadataInsertion.php +++ b/src/Service/MediaConvert/src/ValueObject/TimedMetadataInsertion.php @@ -10,6 +10,8 @@ final class TimedMetadataInsertion { /** * Id3Insertions contains the array of Id3Insertion instances. + * + * @var Id3Insertion[]|null */ private $id3Insertions; diff --git a/src/Service/MediaConvert/src/ValueObject/Timing.php b/src/Service/MediaConvert/src/ValueObject/Timing.php index 81c2f5b17..79de52352 100644 --- a/src/Service/MediaConvert/src/ValueObject/Timing.php +++ b/src/Service/MediaConvert/src/ValueObject/Timing.php @@ -9,16 +9,22 @@ final class Timing { /** * The time, in Unix epoch format, that the transcoding job finished. + * + * @var \DateTimeImmutable|null */ private $finishTime; /** * The time, in Unix epoch format, that transcoding for the job began. + * + * @var \DateTimeImmutable|null */ private $startTime; /** * The time, in Unix epoch format, that you submitted the job. + * + * @var \DateTimeImmutable|null */ private $submitTime; diff --git a/src/Service/MediaConvert/src/ValueObject/TrackSourceSettings.php b/src/Service/MediaConvert/src/ValueObject/TrackSourceSettings.php index b6fbcff02..1279ca075 100644 --- a/src/Service/MediaConvert/src/ValueObject/TrackSourceSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/TrackSourceSettings.php @@ -14,6 +14,8 @@ final class TrackSourceSettings * captions source file. For IMF sources, track numbering is based on the order that the captions appear in the CPL. For * example, use 1 to select the captions asset that is listed first in the CPL. To include more than one captions track * in your job outputs, create multiple input captions selectors. Specify one track per selector. + * + * @var int|null */ private $trackNumber; diff --git a/src/Service/MediaConvert/src/ValueObject/TtmlDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/TtmlDestinationSettings.php index 29fd59174..346dd5160 100644 --- a/src/Service/MediaConvert/src/ValueObject/TtmlDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/TtmlDestinationSettings.php @@ -16,6 +16,8 @@ final class TtmlDestinationSettings { /** * Pass through style and position information from a TTML-like input source (TTML, IMSC, SMPTE-TT) to the TTML output. + * + * @var TtmlStylePassthrough::*|null */ private $stylePassthrough; diff --git a/src/Service/MediaConvert/src/ValueObject/Vc3Settings.php b/src/Service/MediaConvert/src/ValueObject/Vc3Settings.php index 2cdaed301..863d150e6 100644 --- a/src/Service/MediaConvert/src/ValueObject/Vc3Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Vc3Settings.php @@ -25,6 +25,8 @@ final class Vc3Settings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var Vc3FramerateControl::*|null */ private $framerateControl; @@ -37,6 +39,8 @@ final class Vc3Settings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var Vc3FramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -45,6 +49,8 @@ final class Vc3Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -53,12 +59,16 @@ final class Vc3Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; /** * Optional. Choose the scan line type for this output. If you don't specify a value, MediaConvert will create a * progressive output. + * + * @var Vc3InterlaceMode::*|null */ private $interlaceMode; @@ -72,6 +82,8 @@ final class Vc3Settings * basic interlacing. Required settings: To use optimized interlacing, you must set Telecine (telecine) to None (NONE) * or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode * (interlaceMode) to a value other than Progressive (PROGRESSIVE). + * + * @var Vc3ScanTypeConversionMode::*|null */ private $scanTypeConversionMode; @@ -80,6 +92,8 @@ final class Vc3Settings * 25 fps output by relabeling the video frames and resampling your audio. Note that enabling this setting will slightly * reduce the duration of your video. Related settings: You must also set Framerate to 25. In your JSON job * specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. + * + * @var Vc3SlowPal::*|null */ private $slowPal; @@ -88,6 +102,8 @@ final class Vc3Settings * interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default * value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field * polarity to create a smoother picture. + * + * @var Vc3Telecine::*|null */ private $telecine; @@ -97,6 +113,8 @@ final class Vc3Settings * bitrate. For example, say that your video resolution is 1920x1080 and your framerate is 29.97. Then Class 145 * (CLASS_145) gives you an output with a bitrate of approximately 145 Mbps and Class 220 (CLASS_220) gives you and * output with a bitrate of approximately 220 Mbps. VC3 class also specifies the color bit depth of your output. + * + * @var Vc3Class::*|null */ private $vc3Class; diff --git a/src/Service/MediaConvert/src/ValueObject/VideoCodecSettings.php b/src/Service/MediaConvert/src/ValueObject/VideoCodecSettings.php index c6812eab0..c13b16490 100644 --- a/src/Service/MediaConvert/src/ValueObject/VideoCodecSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/VideoCodecSettings.php @@ -17,6 +17,8 @@ final class VideoCodecSettings { /** * Required when you set Codec, under VideoDescription>CodecSettings to the value AV1. + * + * @var Av1Settings|null */ private $av1Settings; @@ -25,6 +27,8 @@ final class VideoCodecSettings * see the relevant specification. For detailed information about SD and HD in AVC-Intra, see * https://ieeexplore.ieee.org/document/7290936. For information about 4K/2K in AVC-Intra, see * https://pro-av.panasonic.net/en/avc-ultra/AVC-ULTRAoverview.pdf. + * + * @var AvcIntraSettings|null */ private $avcIntraSettings; @@ -33,51 +37,71 @@ final class VideoCodecSettings * passthrough the video stream of your input JPEG2000, VC-3, AVC-INTRA or Apple ProRes video without any video * encoding: Choose Passthrough. If you have multiple input videos, note that they must have identical encoding * attributes. When you choose Passthrough, your output container must be MXF or QuickTime MOV. + * + * @var VideoCodec::*|null */ private $codec; /** * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE. + * + * @var FrameCaptureSettings|null */ private $frameCaptureSettings; /** * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264. + * + * @var H264Settings|null */ private $h264Settings; /** * Settings for H265 codec. + * + * @var H265Settings|null */ private $h265Settings; /** * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2. + * + * @var Mpeg2Settings|null */ private $mpeg2Settings; /** * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES. + * + * @var ProresSettings|null */ private $proresSettings; /** * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VC3. + * + * @var Vc3Settings|null */ private $vc3Settings; /** * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP8. + * + * @var Vp8Settings|null */ private $vp8Settings; /** * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP9. + * + * @var Vp9Settings|null */ private $vp9Settings; /** * Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value XAVC. + * + * @var XavcSettings|null */ private $xavcSettings; diff --git a/src/Service/MediaConvert/src/ValueObject/VideoDescription.php b/src/Service/MediaConvert/src/ValueObject/VideoDescription.php index 3575bc8cd..0992c9b8e 100644 --- a/src/Service/MediaConvert/src/ValueObject/VideoDescription.php +++ b/src/Service/MediaConvert/src/ValueObject/VideoDescription.php @@ -23,12 +23,16 @@ final class VideoDescription * whether the service includes AFD values in the output video data and what those values are. * Choose None to remove * all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in * the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data. + * + * @var AfdSignaling::*|null */ private $afdSignaling; /** * The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for * AntiAlias. If you specify that in your job, the service will ignore the setting. + * + * @var AntiAlias::*|null */ private $antiAlias; @@ -39,17 +43,23 @@ final class VideoDescription * object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, * H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, * Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings. + * + * @var VideoCodecSettings|null */ private $codecSettings; /** * Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude * color metadata from this output. If you don't specify a value, the service sets this to Insert by default. + * + * @var ColorMetadata::*|null */ private $colorMetadata; /** * Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. + * + * @var Rectangle|null */ private $crop; @@ -57,12 +67,16 @@ final class VideoDescription * Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. * If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is * enabled by default when Timecode insertion (TimecodeInsertion) is enabled. + * + * @var DropFrameTimecode::*|null */ private $dropFrameTimecode; /** * Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD * value which the service will write on all frames of this video output. + * + * @var int|null */ private $fixedAfd; @@ -70,12 +84,16 @@ final class VideoDescription * Use Height to define the video resolution height, in pixels, for this output. To use the same resolution as your * input: Leave both Width and Height blank. To evenly scale from your input resolution: Leave Height blank and enter a * value for Width. For example, if your input is 1920x1080 and you set Width to 1280, your output will be 1280x720. + * + * @var int|null */ private $height; /** * Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle * that you specify here is black. + * + * @var Rectangle|null */ private $position; @@ -85,6 +103,8 @@ final class VideoDescription * output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when * AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set * AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output. + * + * @var RespondToAfd::*|null */ private $respondToAfd; @@ -93,6 +113,8 @@ final class VideoDescription * Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default * (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the * setting Selection placement (position) in this output. + * + * @var ScalingBehavior::*|null */ private $scalingBehavior; @@ -100,6 +122,8 @@ final class VideoDescription * Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the * anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your * input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content. + * + * @var int|null */ private $sharpness; @@ -113,12 +137,16 @@ final class VideoDescription * Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does * not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration * (TimecodeSource) does. + * + * @var VideoTimecodeInsertion::*|null */ private $timecodeInsertion; /** * Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output * individually. These features are disabled by default. + * + * @var VideoPreprocessor|null */ private $videoPreprocessors; @@ -126,6 +154,8 @@ final class VideoDescription * Use Width to define the video resolution width, in pixels, for this output. To use the same resolution as your input: * Leave both Width and Height blank. To evenly scale from your input resolution: Leave Width blank and enter a value * for Height. For example, if your input is 1920x1080 and you set Height to 720, your output will be 1280x720. + * + * @var int|null */ private $width; diff --git a/src/Service/MediaConvert/src/ValueObject/VideoDetail.php b/src/Service/MediaConvert/src/ValueObject/VideoDetail.php index da28ecc3b..9c237ad06 100644 --- a/src/Service/MediaConvert/src/ValueObject/VideoDetail.php +++ b/src/Service/MediaConvert/src/ValueObject/VideoDetail.php @@ -9,11 +9,15 @@ final class VideoDetail { /** * Height in pixels for the output. + * + * @var int|null */ private $heightInPx; /** * Width in pixels for the output. + * + * @var int|null */ private $widthInPx; diff --git a/src/Service/MediaConvert/src/ValueObject/VideoPreprocessor.php b/src/Service/MediaConvert/src/ValueObject/VideoPreprocessor.php index bbba9c133..90eac87d3 100644 --- a/src/Service/MediaConvert/src/ValueObject/VideoPreprocessor.php +++ b/src/Service/MediaConvert/src/ValueObject/VideoPreprocessor.php @@ -11,28 +11,38 @@ final class VideoPreprocessor /** * Use these settings to convert the color space or to modify properties such as hue and contrast for this output. For * more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/converting-the-color-space.html. + * + * @var ColorCorrector|null */ private $colorCorrector; /** * Use the deinterlacer to produce smoother motion and a clearer picture. For more information, see * https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-scan-type.html. + * + * @var Deinterlacer|null */ private $deinterlacer; /** * Enable Dolby Vision feature to produce Dolby Vision compatible video output. + * + * @var DolbyVision|null */ private $dolbyVision; /** * Enable HDR10+ analyis and metadata injection. Compatible with HEVC only. + * + * @var Hdr10Plus|null */ private $hdr10Plus; /** * Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this * feature for each output individually. This setting is disabled by default. + * + * @var ImageInserter|null */ private $imageInserter; @@ -41,17 +51,23 @@ final class VideoPreprocessor * for each output individually. This setting is disabled by default. When you enable Noise reducer, you must also * select a value for Noise reducer filter. For AVC outputs, when you include Noise reducer, you cannot include the * Bandwidth reduction filter. + * + * @var NoiseReducer|null */ private $noiseReducer; /** * If you work with a third party video watermarking partner, use the group of settings that correspond with your * watermarking partner to include watermarks in your output. + * + * @var PartnerWatermarking|null */ private $partnerWatermarking; /** * Settings for burning the output timecode and specified prefix into the output. + * + * @var TimecodeBurnin|null */ private $timecodeBurnin; diff --git a/src/Service/MediaConvert/src/ValueObject/VideoSelector.php b/src/Service/MediaConvert/src/ValueObject/VideoSelector.php index f217e36d0..3f58e6675 100644 --- a/src/Service/MediaConvert/src/ValueObject/VideoSelector.php +++ b/src/Service/MediaConvert/src/ValueObject/VideoSelector.php @@ -22,6 +22,8 @@ final class VideoSelector * separate Key and Fill outputs. In each output, specify which part of the input MediaConvert uses. Leave this setting * at the default value DISCARD to delete the alpha channel and preserve the video. Set it to REMAP_TO_LUMA to delete * the video and map the alpha channel to the luma channel of your outputs. + * + * @var AlphaBehavior::*|null */ private $alphaBehavior; @@ -39,6 +41,8 @@ final class VideoSelector * * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * * P3D65 (SDR): Display P3, sRGB, BT.709 * * P3D65 (HDR): Display P3, PQ, BT.709. + * + * @var ColorSpace::*|null */ private $colorSpace; @@ -49,6 +53,8 @@ final class VideoSelector * settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use color * metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to * using values you specify in the input settings. + * + * @var ColorSpaceUsage::*|null */ private $colorSpaceUsage; @@ -57,6 +63,8 @@ final class VideoSelector * timecode tag data in the Modified Digital Video Pack Metadata (MDPM). When you do, we recommend you also set Timecode * source (inputTimecodeSource) to Embedded (EMBEDDED). Leave Embedded timecode override blank, or set to None (NONE), * when your input does not contain MDPM timecode. + * + * @var EmbeddedTimecodeOverride::*|null */ private $embeddedTimecodeOverride; @@ -69,6 +77,8 @@ final class VideoSelector * the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify whether color * metadata is included in an output, set Color metadata (ColorMetadata). For more information about MediaConvert HDR * jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. + * + * @var Hdr10Metadata|null */ private $hdr10Metadata; @@ -78,6 +88,8 @@ final class VideoSelector * When you set Pad video (padVideo) to Black (BLACK), MediaConvert generates black video frames so that output video * and audio durations match. Black video frames are added at the beginning or end, depending on your input. To keep the * default behavior and not generate black video, set Pad video to Disabled (DISABLED) or leave blank. + * + * @var PadVideo::*|null */ private $padVideo; @@ -85,12 +97,16 @@ final class VideoSelector * Use PID (Pid) to select specific video data from an input file. Specify this value as an integer; the system * automatically converts it to the hexidecimal value. For example, 257 selects PID 0x101. A PID, or packet identifier, * is an identifier for a set of data in an MPEG-2 transport stream container. + * + * @var int|null */ private $pid; /** * Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently * supported. + * + * @var int|null */ private $programNumber; @@ -102,6 +118,8 @@ final class VideoSelector * degrees. If the rotation metadata specifies any other rotation, the service will default to no rotation. By default, * the service does no rotation, even if your input video has rotation metadata. The service doesn't pass through * rotation metadata. + * + * @var InputRotate::*|null */ private $rotate; @@ -112,6 +130,8 @@ final class VideoSelector * When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether * MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for * transcoding and also writes it to the output metadata. + * + * @var InputSampleRange::*|null */ private $sampleRange; diff --git a/src/Service/MediaConvert/src/ValueObject/VorbisSettings.php b/src/Service/MediaConvert/src/ValueObject/VorbisSettings.php index 56b4aa817..8ffe64785 100644 --- a/src/Service/MediaConvert/src/ValueObject/VorbisSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/VorbisSettings.php @@ -10,12 +10,16 @@ final class VorbisSettings /** * Optional. Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output * channel; choosing Stereo gives you 2. In the API, valid values are 1 and 2. The default value is 2. + * + * @var int|null */ private $channels; /** * Optional. Specify the audio sample rate in Hz. Valid values are 22050, 32000, 44100, and 48000. The default value is * 48000. + * + * @var int|null */ private $sampleRate; @@ -23,6 +27,8 @@ final class VorbisSettings * Optional. Specify the variable audio quality of this Vorbis output from -1 (lowest quality, ~45 kbit/s) to 10 * (highest quality, ~500 kbit/s). The default value is 4 (~128 kbit/s). Values 5 and 6 are approximately 160 and 192 * kbit/s, respectively. + * + * @var int|null */ private $vbrQuality; diff --git a/src/Service/MediaConvert/src/ValueObject/Vp8Settings.php b/src/Service/MediaConvert/src/ValueObject/Vp8Settings.php index 09f439000..b0bae86db 100644 --- a/src/Service/MediaConvert/src/ValueObject/Vp8Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Vp8Settings.php @@ -16,6 +16,8 @@ final class Vp8Settings { /** * Target bitrate in bits/second. For example, enter five megabits per second as 5000000. + * + * @var int|null */ private $bitrate; @@ -28,6 +30,8 @@ final class Vp8Settings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var Vp8FramerateControl::*|null */ private $framerateControl; @@ -40,6 +44,8 @@ final class Vp8Settings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var Vp8FramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -48,6 +54,8 @@ final class Vp8Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -56,16 +64,22 @@ final class Vp8Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; /** * GOP Length (keyframe interval) in frames. Must be greater than zero. + * + * @var float|null */ private $gopSize; /** * Optional. Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. + * + * @var int|null */ private $hrdBufferSize; @@ -73,6 +87,8 @@ final class Vp8Settings * Ignore this setting unless you set qualityTuningLevel to MULTI_PASS. Optional. Specify the maximum bitrate in * bits/second. For example, enter five megabits per second as 5000000. The default behavior uses twice the target * bitrate as the maximum bitrate. + * + * @var int|null */ private $maxBitrate; @@ -82,6 +98,8 @@ final class Vp8Settings * PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job * specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the * parNumerator and parDenominator settings. + * + * @var Vp8ParControl::*|null */ private $parControl; @@ -90,6 +108,8 @@ final class Vp8Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parDenominator is 33. + * + * @var int|null */ private $parDenominator; @@ -98,17 +118,23 @@ final class Vp8Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parNumerator is 40. + * + * @var int|null */ private $parNumerator; /** * Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output * video quality. The default behavior is faster, lower quality, multi-pass encoding. + * + * @var Vp8QualityTuningLevel::*|null */ private $qualityTuningLevel; /** * With the VP8 codec, you can use only the variable bitrate (VBR) rate control mode. + * + * @var Vp8RateControlMode::*|null */ private $rateControlMode; diff --git a/src/Service/MediaConvert/src/ValueObject/Vp9Settings.php b/src/Service/MediaConvert/src/ValueObject/Vp9Settings.php index 74c217086..93341f5ae 100644 --- a/src/Service/MediaConvert/src/ValueObject/Vp9Settings.php +++ b/src/Service/MediaConvert/src/ValueObject/Vp9Settings.php @@ -16,6 +16,8 @@ final class Vp9Settings { /** * Target bitrate in bits/second. For example, enter five megabits per second as 5000000. + * + * @var int|null */ private $bitrate; @@ -28,6 +30,8 @@ final class Vp9Settings * service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the * frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings * FramerateNumerator and FramerateDenominator. + * + * @var Vp9FramerateControl::*|null */ private $framerateControl; @@ -40,6 +44,8 @@ final class Vp9Settings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var Vp9FramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -48,6 +54,8 @@ final class Vp9Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -56,16 +64,22 @@ final class Vp9Settings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; /** * GOP Length (keyframe interval) in frames. Must be greater than zero. + * + * @var float|null */ private $gopSize; /** * Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. + * + * @var int|null */ private $hrdBufferSize; @@ -73,12 +87,16 @@ final class Vp9Settings * Ignore this setting unless you set qualityTuningLevel to MULTI_PASS. Optional. Specify the maximum bitrate in * bits/second. For example, enter five megabits per second as 5000000. The default behavior uses twice the target * bitrate as the maximum bitrate. + * + * @var int|null */ private $maxBitrate; /** * Optional. Specify how the service determines the pixel aspect ratio for this output. The default behavior is to use * the same pixel aspect ratio as your input video. + * + * @var Vp9ParControl::*|null */ private $parControl; @@ -87,6 +105,8 @@ final class Vp9Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parDenominator is 33. + * + * @var int|null */ private $parDenominator; @@ -95,17 +115,23 @@ final class Vp9Settings * other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video * PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. * In this example, the value for parNumerator is 40. + * + * @var int|null */ private $parNumerator; /** * Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output * video quality. The default behavior is faster, lower quality, multi-pass encoding. + * + * @var Vp9QualityTuningLevel::*|null */ private $qualityTuningLevel; /** * With the VP9 codec, you can use only the variable bitrate (VBR) rate control mode. + * + * @var Vp9RateControlMode::*|null */ private $rateControlMode; diff --git a/src/Service/MediaConvert/src/ValueObject/WarningGroup.php b/src/Service/MediaConvert/src/ValueObject/WarningGroup.php index 3f273f9b5..99f043ca2 100644 --- a/src/Service/MediaConvert/src/ValueObject/WarningGroup.php +++ b/src/Service/MediaConvert/src/ValueObject/WarningGroup.php @@ -12,11 +12,15 @@ final class WarningGroup /** * Warning code that identifies a specific warning in the job. For more information, see * https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html. + * + * @var int */ private $code; /** * The number of times this warning occurred in the job. + * + * @var int */ private $count; diff --git a/src/Service/MediaConvert/src/ValueObject/WavSettings.php b/src/Service/MediaConvert/src/ValueObject/WavSettings.php index 9cf60fbe3..d1b3c8d04 100644 --- a/src/Service/MediaConvert/src/ValueObject/WavSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/WavSettings.php @@ -12,23 +12,31 @@ final class WavSettings { /** * Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track. + * + * @var int|null */ private $bitDepth; /** * Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, * 1, 2, 4, 6, and so on, up to 64. + * + * @var int|null */ private $channels; /** * The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if * you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64. + * + * @var WavFormat::*|null */ private $format; /** * Sample rate in Hz. + * + * @var int|null */ private $sampleRate; diff --git a/src/Service/MediaConvert/src/ValueObject/WebvttDestinationSettings.php b/src/Service/MediaConvert/src/ValueObject/WebvttDestinationSettings.php index 4cad9e57e..b7779ea3e 100644 --- a/src/Service/MediaConvert/src/ValueObject/WebvttDestinationSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/WebvttDestinationSettings.php @@ -25,6 +25,8 @@ final class WebvttDestinationSettings * provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead * adds the following in the adaptation set for this track: ``. + * + * @var WebvttAccessibilitySubs::*|null */ private $accessibility; @@ -35,6 +37,8 @@ final class WebvttDestinationSettings * MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, * and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your * input captions and use simplified output captions: Set Style passthrough to Disabled (DISABLED), or leave blank. + * + * @var WebvttStylePassthrough::*|null */ private $stylePassthrough; diff --git a/src/Service/MediaConvert/src/ValueObject/WebvttHlsSourceSettings.php b/src/Service/MediaConvert/src/ValueObject/WebvttHlsSourceSettings.php index 9d9251ad8..837c84b9f 100644 --- a/src/Service/MediaConvert/src/ValueObject/WebvttHlsSourceSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/WebvttHlsSourceSettings.php @@ -17,16 +17,22 @@ final class WebvttHlsSourceSettings { /** * Optional. Specify alternative group ID. + * + * @var string|null */ private $renditionGroupId; /** * Optional. Specify ISO 639-2 or ISO 639-3 code in the language property. + * + * @var LanguageCode::*|null */ private $renditionLanguageCode; /** * Optional. Specify media name. + * + * @var string|null */ private $renditionName; diff --git a/src/Service/MediaConvert/src/ValueObject/Xavc4kIntraCbgProfileSettings.php b/src/Service/MediaConvert/src/ValueObject/Xavc4kIntraCbgProfileSettings.php index 866c792aa..a7c97cfd6 100644 --- a/src/Service/MediaConvert/src/ValueObject/Xavc4kIntraCbgProfileSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/Xavc4kIntraCbgProfileSettings.php @@ -14,6 +14,8 @@ final class Xavc4kIntraCbgProfileSettings /** * Specify the XAVC Intra 4k (CBG) Class to set the bitrate of your output. Outputs of the same class have similar image * quality over the operating points that are valid for that class. + * + * @var Xavc4kIntraCbgProfileClass::*|null */ private $xavcClass; diff --git a/src/Service/MediaConvert/src/ValueObject/Xavc4kIntraVbrProfileSettings.php b/src/Service/MediaConvert/src/ValueObject/Xavc4kIntraVbrProfileSettings.php index 7b13551b3..e28a6984c 100644 --- a/src/Service/MediaConvert/src/ValueObject/Xavc4kIntraVbrProfileSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/Xavc4kIntraVbrProfileSettings.php @@ -14,6 +14,8 @@ final class Xavc4kIntraVbrProfileSettings /** * Specify the XAVC Intra 4k (VBR) Class to set the bitrate of your output. Outputs of the same class have similar image * quality over the operating points that are valid for that class. + * + * @var Xavc4kIntraVbrProfileClass::*|null */ private $xavcClass; diff --git a/src/Service/MediaConvert/src/ValueObject/Xavc4kProfileSettings.php b/src/Service/MediaConvert/src/ValueObject/Xavc4kProfileSettings.php index 0a12d63b9..0c55884f9 100644 --- a/src/Service/MediaConvert/src/ValueObject/Xavc4kProfileSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/Xavc4kProfileSettings.php @@ -17,12 +17,16 @@ final class Xavc4kProfileSettings /** * Specify the XAVC 4k (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have * similar image quality over the operating points that are valid for that class. + * + * @var Xavc4kProfileBitrateClass::*|null */ private $bitrateClass; /** * Specify the codec profile for this output. Choose High, 8-bit, 4:2:0 (HIGH) or High, 10-bit, 4:2:2 (HIGH_422). These * profiles are specified in ITU-T H.264. + * + * @var Xavc4kProfileCodecProfile::*|null */ private $codecProfile; @@ -37,6 +41,8 @@ final class Xavc4kProfileSettings * setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a * value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker * adaptive quantization provides. + * + * @var XavcFlickerAdaptiveQuantization::*|null */ private $flickerAdaptiveQuantization; @@ -44,12 +50,16 @@ final class Xavc4kProfileSettings * Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow * (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the * encoder from using B-frames as reference frames. + * + * @var XavcGopBReference::*|null */ private $gopBreference; /** * Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining * mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. + * + * @var int|null */ private $gopClosedCadence; @@ -57,18 +67,24 @@ final class Xavc4kProfileSettings * Specify the size of the buffer that MediaConvert uses in the HRD buffer model for this output. Specify this value in * bits; for example, enter five megabits as 5000000. When you don't set this value, or you set it to zero, MediaConvert * calculates the default by doubling the bitrate of this output point. + * + * @var int|null */ private $hrdBufferSize; /** * Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output * video quality. The default behavior is faster, lower quality, single-pass encoding. + * + * @var Xavc4kProfileQualityTuningLevel::*|null */ private $qualityTuningLevel; /** * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, * and less than or equal to half the number of macroblock rows for interlaced pictures. + * + * @var int|null */ private $slices; diff --git a/src/Service/MediaConvert/src/ValueObject/XavcHdIntraCbgProfileSettings.php b/src/Service/MediaConvert/src/ValueObject/XavcHdIntraCbgProfileSettings.php index d3092cf16..0b1392506 100644 --- a/src/Service/MediaConvert/src/ValueObject/XavcHdIntraCbgProfileSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/XavcHdIntraCbgProfileSettings.php @@ -14,6 +14,8 @@ final class XavcHdIntraCbgProfileSettings /** * Specify the XAVC Intra HD (CBG) Class to set the bitrate of your output. Outputs of the same class have similar image * quality over the operating points that are valid for that class. + * + * @var XavcHdIntraCbgProfileClass::*|null */ private $xavcClass; diff --git a/src/Service/MediaConvert/src/ValueObject/XavcHdProfileSettings.php b/src/Service/MediaConvert/src/ValueObject/XavcHdProfileSettings.php index f09690840..3db1f2897 100644 --- a/src/Service/MediaConvert/src/ValueObject/XavcHdProfileSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/XavcHdProfileSettings.php @@ -18,6 +18,8 @@ final class XavcHdProfileSettings /** * Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have * similar image quality over the operating points that are valid for that class. + * + * @var XavcHdProfileBitrateClass::*|null */ private $bitrateClass; @@ -32,6 +34,8 @@ final class XavcHdProfileSettings * setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a * value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker * adaptive quantization provides. + * + * @var XavcFlickerAdaptiveQuantization::*|null */ private $flickerAdaptiveQuantization; @@ -39,12 +43,16 @@ final class XavcHdProfileSettings * Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow * (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the * encoder from using B-frames as reference frames. + * + * @var XavcGopBReference::*|null */ private $gopBreference; /** * Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining * mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. + * + * @var int|null */ private $gopClosedCadence; @@ -52,6 +60,8 @@ final class XavcHdProfileSettings * Specify the size of the buffer that MediaConvert uses in the HRD buffer model for this output. Specify this value in * bits; for example, enter five megabits as 5000000. When you don't set this value, or you set it to zero, MediaConvert * calculates the default by doubling the bitrate of this output point. + * + * @var int|null */ private $hrdBufferSize; @@ -64,18 +74,24 @@ final class XavcHdProfileSettings * Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the * same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field * first, depending on which of the Follow options you choose. + * + * @var XavcInterlaceMode::*|null */ private $interlaceMode; /** * Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output * video quality. The default behavior is faster, lower quality, single-pass encoding. + * + * @var XavcHdProfileQualityTuningLevel::*|null */ private $qualityTuningLevel; /** * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, * and less than or equal to half the number of macroblock rows for interlaced pictures. + * + * @var int|null */ private $slices; @@ -83,6 +99,8 @@ final class XavcHdProfileSettings * Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970. If your * input framerate is 23.976, choose Hard (HARD). Otherwise, keep the default value None (NONE). For more information, * see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-telecine-and-inverse-telecine.html. + * + * @var XavcHdProfileTelecine::*|null */ private $telecine; diff --git a/src/Service/MediaConvert/src/ValueObject/XavcSettings.php b/src/Service/MediaConvert/src/ValueObject/XavcSettings.php index d3f755f09..25cc49c33 100644 --- a/src/Service/MediaConvert/src/ValueObject/XavcSettings.php +++ b/src/Service/MediaConvert/src/ValueObject/XavcSettings.php @@ -25,12 +25,16 @@ final class XavcSettings * quantization in this transcode, set Adaptive quantization to Off (OFF). Related settings: The value that you choose * here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive * quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization). + * + * @var XavcAdaptiveQuantization::*|null */ private $adaptiveQuantization; /** * Optional. Choose a specific entropy encoding mode only when you want to override XAVC recommendations. If you choose * the value auto, MediaConvert uses the mode that the XAVC file format specifies given this output's operating point. + * + * @var XavcEntropyEncoding::*|null */ private $entropyEncoding; @@ -42,6 +46,8 @@ final class XavcSettings * specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want * the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate that * you specify in the settings FramerateNumerator and FramerateDenominator. + * + * @var XavcFramerateControl::*|null */ private $framerateControl; @@ -54,6 +60,8 @@ final class XavcSettings * FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding * time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least * 128x96. + * + * @var XavcFramerateConversionAlgorithm::*|null */ private $framerateConversionAlgorithm; @@ -62,6 +70,8 @@ final class XavcSettings * example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this * example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Frame rate. In this example, specify 23.976. + * + * @var int|null */ private $framerateDenominator; @@ -70,6 +80,8 @@ final class XavcSettings * example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this * example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame * rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. + * + * @var int|null */ private $framerateNumerator; @@ -77,6 +89,8 @@ final class XavcSettings * Specify the XAVC profile for this output. For more information, see the Sony documentation at * https://www.xavc-info.org/. Note that MediaConvert doesn't support the interlaced video XAVC operating points for * XAVC_HD_INTRA_CBG. To create an interlaced XAVC output, choose the profile XAVC_HD. + * + * @var XavcProfile::*|null */ private $profile; @@ -85,6 +99,8 @@ final class XavcSettings * 25 fps output by relabeling the video frames and resampling your audio. Note that enabling this setting will slightly * reduce the duration of your video. Related settings: You must also set Frame rate to 25. In your JSON job * specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. + * + * @var XavcSlowPal::*|null */ private $slowPal; @@ -96,6 +112,8 @@ final class XavcSettings * default JVT softening quantization matricies from the H.264 specification. Choose a value from 17 to 128 to use * planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The * value 128 results in the softest video. + * + * @var int|null */ private $softness; @@ -114,6 +132,8 @@ final class XavcSettings * set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, * such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or * Higher. + * + * @var XavcSpatialAdaptiveQuantization::*|null */ private $spatialAdaptiveQuantization; @@ -130,34 +150,46 @@ final class XavcSettings * focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports * athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal adaptive * quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization). + * + * @var XavcTemporalAdaptiveQuantization::*|null */ private $temporalAdaptiveQuantization; /** * Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value * XAVC_4K_INTRA_CBG. + * + * @var Xavc4kIntraCbgProfileSettings|null */ private $xavc4kIntraCbgProfileSettings; /** * Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value * XAVC_4K_INTRA_VBR. + * + * @var Xavc4kIntraVbrProfileSettings|null */ private $xavc4kIntraVbrProfileSettings; /** * Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_4K. + * + * @var Xavc4kProfileSettings|null */ private $xavc4kProfileSettings; /** * Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value * XAVC_HD_INTRA_CBG. + * + * @var XavcHdIntraCbgProfileSettings|null */ private $xavcHdIntraCbgProfileSettings; /** * Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_HD. + * + * @var XavcHdProfileSettings|null */ private $xavcHdProfileSettings; diff --git a/src/Service/RdsDataService/src/Exception/StatementTimeoutException.php b/src/Service/RdsDataService/src/Exception/StatementTimeoutException.php index f429399f4..99e75328f 100644 --- a/src/Service/RdsDataService/src/Exception/StatementTimeoutException.php +++ b/src/Service/RdsDataService/src/Exception/StatementTimeoutException.php @@ -12,6 +12,8 @@ final class StatementTimeoutException extends ClientException { /** * The database connection ID that executed the SQL statement. + * + * @var int|null */ private $dbConnectionId; diff --git a/src/Service/RdsDataService/src/Result/BatchExecuteStatementResponse.php b/src/Service/RdsDataService/src/Result/BatchExecuteStatementResponse.php index 9a4ba4bb7..4a911993b 100644 --- a/src/Service/RdsDataService/src/Result/BatchExecuteStatementResponse.php +++ b/src/Service/RdsDataService/src/Result/BatchExecuteStatementResponse.php @@ -15,6 +15,8 @@ class BatchExecuteStatementResponse extends Result { /** * The execution results of each batch entry. + * + * @var UpdateResult[] */ private $updateResults; diff --git a/src/Service/RdsDataService/src/Result/BeginTransactionResponse.php b/src/Service/RdsDataService/src/Result/BeginTransactionResponse.php index 50d7d36b4..381a7990a 100644 --- a/src/Service/RdsDataService/src/Result/BeginTransactionResponse.php +++ b/src/Service/RdsDataService/src/Result/BeginTransactionResponse.php @@ -12,6 +12,8 @@ class BeginTransactionResponse extends Result { /** * The transaction ID of the transaction started by the call. + * + * @var string|null */ private $transactionId; diff --git a/src/Service/RdsDataService/src/Result/CommitTransactionResponse.php b/src/Service/RdsDataService/src/Result/CommitTransactionResponse.php index cfaa9f945..463e5c64a 100644 --- a/src/Service/RdsDataService/src/Result/CommitTransactionResponse.php +++ b/src/Service/RdsDataService/src/Result/CommitTransactionResponse.php @@ -12,6 +12,8 @@ class CommitTransactionResponse extends Result { /** * The status of the commit operation. + * + * @var string|null */ private $transactionStatus; diff --git a/src/Service/RdsDataService/src/Result/ExecuteStatementResponse.php b/src/Service/RdsDataService/src/Result/ExecuteStatementResponse.php index 6765040e7..220b1dfa9 100644 --- a/src/Service/RdsDataService/src/Result/ExecuteStatementResponse.php +++ b/src/Service/RdsDataService/src/Result/ExecuteStatementResponse.php @@ -15,17 +15,23 @@ class ExecuteStatementResponse extends Result { /** * The records returned by the SQL statement. This field is blank if the `formatRecordsAs` parameter is set to `JSON`. + * + * @var Field[][] */ private $records; /** * Metadata for the columns included in the results. This field is blank if the `formatRecordsAs` parameter is set to * `JSON`. + * + * @var ColumnMetadata[] */ private $columnMetadata; /** * The number of records updated by the request. + * + * @var int|null */ private $numberOfRecordsUpdated; @@ -36,6 +42,8 @@ class ExecuteStatementResponse extends Result * href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows * in the PostgreSQL documentation.

* ```. + * + * @var Field[] */ private $generatedFields; @@ -45,6 +53,8 @@ class ExecuteStatementResponse extends Result * * The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires * more than 10 MB, the call returns an error. + * + * @var string|null */ private $formattedRecords; diff --git a/src/Service/RdsDataService/src/Result/RollbackTransactionResponse.php b/src/Service/RdsDataService/src/Result/RollbackTransactionResponse.php index e0637e2d2..e7a9da1c1 100644 --- a/src/Service/RdsDataService/src/Result/RollbackTransactionResponse.php +++ b/src/Service/RdsDataService/src/Result/RollbackTransactionResponse.php @@ -12,6 +12,8 @@ class RollbackTransactionResponse extends Result { /** * The status of the rollback operation. + * + * @var string|null */ private $transactionStatus; diff --git a/src/Service/RdsDataService/src/ValueObject/ArrayValue.php b/src/Service/RdsDataService/src/ValueObject/ArrayValue.php index c35c8901a..9f63111a4 100644 --- a/src/Service/RdsDataService/src/ValueObject/ArrayValue.php +++ b/src/Service/RdsDataService/src/ValueObject/ArrayValue.php @@ -9,26 +9,36 @@ final class ArrayValue { /** * An array of Boolean values. + * + * @var bool[]|null */ private $booleanValues; /** * An array of integers. + * + * @var int[]|null */ private $longValues; /** * An array of floating-point numbers. + * + * @var float[]|null */ private $doubleValues; /** * An array of strings. + * + * @var string[]|null */ private $stringValues; /** * An array of arrays. + * + * @var ArrayValue[]|null */ private $arrayValues; diff --git a/src/Service/RdsDataService/src/ValueObject/ColumnMetadata.php b/src/Service/RdsDataService/src/ValueObject/ColumnMetadata.php index dc6de2983..5fe15e5fc 100644 --- a/src/Service/RdsDataService/src/ValueObject/ColumnMetadata.php +++ b/src/Service/RdsDataService/src/ValueObject/ColumnMetadata.php @@ -9,71 +9,99 @@ final class ColumnMetadata { /** * The name of the column. + * + * @var string|null */ private $name; /** * The type of the column. + * + * @var int|null */ private $type; /** * The database-specific data type of the column. + * + * @var string|null */ private $typeName; /** * The label for the column. + * + * @var string|null */ private $label; /** * The name of the schema that owns the table that includes the column. + * + * @var string|null */ private $schemaName; /** * The name of the table that includes the column. + * + * @var string|null */ private $tableName; /** * A value that indicates whether the column increments automatically. + * + * @var bool|null */ private $isAutoIncrement; /** * A value that indicates whether an integer column is signed. + * + * @var bool|null */ private $isSigned; /** * A value that indicates whether the column contains currency values. + * + * @var bool|null */ private $isCurrency; /** * A value that indicates whether the column is case-sensitive. + * + * @var bool|null */ private $isCaseSensitive; /** * A value that indicates whether the column is nullable. + * + * @var int|null */ private $nullable; /** * The precision value of a decimal number column. + * + * @var int|null */ private $precision; /** * The scale value of a decimal number column. + * + * @var int|null */ private $scale; /** * The type of the column. + * + * @var int|null */ private $arrayBaseColumnType; diff --git a/src/Service/RdsDataService/src/ValueObject/Field.php b/src/Service/RdsDataService/src/ValueObject/Field.php index 27c30a10f..568d70599 100644 --- a/src/Service/RdsDataService/src/ValueObject/Field.php +++ b/src/Service/RdsDataService/src/ValueObject/Field.php @@ -9,36 +9,50 @@ final class Field { /** * A NULL value. + * + * @var bool|null */ private $isNull; /** * A value of Boolean data type. + * + * @var bool|null */ private $booleanValue; /** * A value of long data type. + * + * @var int|null */ private $longValue; /** * A value of double data type. + * + * @var float|null */ private $doubleValue; /** * A value of string data type. + * + * @var string|null */ private $stringValue; /** * A value of BLOB data type. + * + * @var string|null */ private $blobValue; /** * An array of values. + * + * @var ArrayValue|null */ private $arrayValue; diff --git a/src/Service/RdsDataService/src/ValueObject/ResultSetOptions.php b/src/Service/RdsDataService/src/ValueObject/ResultSetOptions.php index 8c6929b97..2af823e6c 100644 --- a/src/Service/RdsDataService/src/ValueObject/ResultSetOptions.php +++ b/src/Service/RdsDataService/src/ValueObject/ResultSetOptions.php @@ -18,12 +18,16 @@ final class ResultSetOptions * * > Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to * > String, especially when working with currency values. + * + * @var DecimalReturnType::*|null */ private $decimalReturnType; /** * A value that indicates how a field of `LONG` type is represented. Allowed values are `LONG` and `STRING`. The default * is `LONG`. Specify `STRING` if the length or precision of numeric values might cause truncation or rounding errors. + * + * @var LongReturnType::*|null */ private $longReturnType; diff --git a/src/Service/RdsDataService/src/ValueObject/SqlParameter.php b/src/Service/RdsDataService/src/ValueObject/SqlParameter.php index 9f1d20ea8..c62716a83 100644 --- a/src/Service/RdsDataService/src/ValueObject/SqlParameter.php +++ b/src/Service/RdsDataService/src/ValueObject/SqlParameter.php @@ -12,11 +12,15 @@ final class SqlParameter { /** * The name of the parameter. + * + * @var string|null */ private $name; /** * The value of the parameter. + * + * @var Field|null */ private $value; @@ -32,6 +36,8 @@ final class SqlParameter * - `TIMESTAMP` - The corresponding `String` parameter value is sent as an object of `TIMESTAMP` type to the database. * The accepted format is `YYYY-MM-DD HH:MM:SS[.FFF]`. * - `UUID` - The corresponding `String` parameter value is sent as an object of `UUID` type to the database. + * + * @var TypeHint::*|null */ private $typeHint; diff --git a/src/Service/RdsDataService/src/ValueObject/UpdateResult.php b/src/Service/RdsDataService/src/ValueObject/UpdateResult.php index 984b03228..2e88604a0 100644 --- a/src/Service/RdsDataService/src/ValueObject/UpdateResult.php +++ b/src/Service/RdsDataService/src/ValueObject/UpdateResult.php @@ -9,6 +9,8 @@ final class UpdateResult { /** * Values for fields generated during the request. + * + * @var Field[]|null */ private $generatedFields; diff --git a/src/Service/Rekognition/src/Exception/HumanLoopQuotaExceededException.php b/src/Service/Rekognition/src/Exception/HumanLoopQuotaExceededException.php index 29a924df1..2ca365867 100644 --- a/src/Service/Rekognition/src/Exception/HumanLoopQuotaExceededException.php +++ b/src/Service/Rekognition/src/Exception/HumanLoopQuotaExceededException.php @@ -12,16 +12,22 @@ final class HumanLoopQuotaExceededException extends ClientException { /** * The resource type. + * + * @var string|null */ private $resourceType; /** * The quota code. + * + * @var string|null */ private $quotaCode; /** * The service code. + * + * @var string|null */ private $serviceCode; diff --git a/src/Service/Rekognition/src/Result/CreateCollectionResponse.php b/src/Service/Rekognition/src/Result/CreateCollectionResponse.php index c4b792adc..5595d19a0 100644 --- a/src/Service/Rekognition/src/Result/CreateCollectionResponse.php +++ b/src/Service/Rekognition/src/Result/CreateCollectionResponse.php @@ -9,16 +9,22 @@ class CreateCollectionResponse extends Result { /** * HTTP status code indicating the result of the operation. + * + * @var int|null */ private $statusCode; /** * Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources. + * + * @var string|null */ private $collectionArn; /** * Version number of the face detection model associated with the collection you are creating. + * + * @var string|null */ private $faceModelVersion; diff --git a/src/Service/Rekognition/src/Result/CreateProjectResponse.php b/src/Service/Rekognition/src/Result/CreateProjectResponse.php index 0ec9964bb..7d9785116 100644 --- a/src/Service/Rekognition/src/Result/CreateProjectResponse.php +++ b/src/Service/Rekognition/src/Result/CreateProjectResponse.php @@ -9,6 +9,8 @@ class CreateProjectResponse extends Result { /** * The Amazon Resource Name (ARN) of the new project. You can use the ARN to configure IAM access to the project. + * + * @var string|null */ private $projectArn; diff --git a/src/Service/Rekognition/src/Result/DeleteCollectionResponse.php b/src/Service/Rekognition/src/Result/DeleteCollectionResponse.php index 28e44e258..4df1eb804 100644 --- a/src/Service/Rekognition/src/Result/DeleteCollectionResponse.php +++ b/src/Service/Rekognition/src/Result/DeleteCollectionResponse.php @@ -9,6 +9,8 @@ class DeleteCollectionResponse extends Result { /** * HTTP status code that indicates the result of the operation. + * + * @var int|null */ private $statusCode; diff --git a/src/Service/Rekognition/src/Result/DeleteProjectResponse.php b/src/Service/Rekognition/src/Result/DeleteProjectResponse.php index 6d9e85bf7..1f7a24414 100644 --- a/src/Service/Rekognition/src/Result/DeleteProjectResponse.php +++ b/src/Service/Rekognition/src/Result/DeleteProjectResponse.php @@ -10,6 +10,8 @@ class DeleteProjectResponse extends Result { /** * The current status of the delete project operation. + * + * @var ProjectStatus::*|null */ private $status; diff --git a/src/Service/Rekognition/src/Result/DetectFacesResponse.php b/src/Service/Rekognition/src/Result/DetectFacesResponse.php index 423ac0792..09a2669a4 100644 --- a/src/Service/Rekognition/src/Result/DetectFacesResponse.php +++ b/src/Service/Rekognition/src/Result/DetectFacesResponse.php @@ -27,6 +27,8 @@ class DetectFacesResponse extends Result { /** * Details of each face found in the image. + * + * @var FaceDetail[] */ private $faceDetails; @@ -41,6 +43,8 @@ class DetectFacesResponse extends Result * Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation * information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object * locations before the image is rotated. + * + * @var OrientationCorrection::*|null */ private $orientationCorrection; diff --git a/src/Service/Rekognition/src/Result/DetectModerationLabelsResponse.php b/src/Service/Rekognition/src/Result/DetectModerationLabelsResponse.php index a85eb0f72..6b1a2084f 100644 --- a/src/Service/Rekognition/src/Result/DetectModerationLabelsResponse.php +++ b/src/Service/Rekognition/src/Result/DetectModerationLabelsResponse.php @@ -11,16 +11,22 @@ class DetectModerationLabelsResponse extends Result { /** * Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected. + * + * @var ModerationLabel[] */ private $moderationLabels; /** * Version number of the moderation detection model that was used to detect unsafe content. + * + * @var string|null */ private $moderationModelVersion; /** * Shows the results of the human in the loop evaluation. + * + * @var HumanLoopActivationOutput|null */ private $humanLoopActivationOutput; diff --git a/src/Service/Rekognition/src/Result/GetCelebrityInfoResponse.php b/src/Service/Rekognition/src/Result/GetCelebrityInfoResponse.php index 718e75430..582714ac3 100644 --- a/src/Service/Rekognition/src/Result/GetCelebrityInfoResponse.php +++ b/src/Service/Rekognition/src/Result/GetCelebrityInfoResponse.php @@ -10,16 +10,22 @@ class GetCelebrityInfoResponse extends Result { /** * An array of URLs pointing to additional celebrity information. + * + * @var string[] */ private $urls; /** * The name of the celebrity. + * + * @var string|null */ private $name; /** * Retrieves the known gender for the celebrity. + * + * @var KnownGender|null */ private $knownGender; diff --git a/src/Service/Rekognition/src/Result/IndexFacesResponse.php b/src/Service/Rekognition/src/Result/IndexFacesResponse.php index bce01ad1b..f68c4a4bf 100644 --- a/src/Service/Rekognition/src/Result/IndexFacesResponse.php +++ b/src/Service/Rekognition/src/Result/IndexFacesResponse.php @@ -32,6 +32,8 @@ class IndexFacesResponse extends Result /** * An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in * the Amazon Rekognition Developer Guide. + * + * @var FaceRecord[] */ private $faceRecords; @@ -53,11 +55,15 @@ class IndexFacesResponse extends Result * * Bounding box information is returned in the `FaceRecords` array. You can get the version of the face detection model * by calling DescribeCollection. + * + * @var OrientationCorrection::*|null */ private $orientationCorrection; /** * The version number of the face detection model that's associated with the input collection (`CollectionId`). + * + * @var string|null */ private $faceModelVersion; @@ -65,6 +71,8 @@ class IndexFacesResponse extends Result * An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality * filter identified them as low quality, or the `MaxFaces` request parameter filtered them out. To use the quality * filter, you specify the `QualityFilter` request parameter. + * + * @var UnindexedFace[] */ private $unindexedFaces; diff --git a/src/Service/Rekognition/src/Result/ListCollectionsResponse.php b/src/Service/Rekognition/src/Result/ListCollectionsResponse.php index a92b4a948..2a8e21186 100644 --- a/src/Service/Rekognition/src/Result/ListCollectionsResponse.php +++ b/src/Service/Rekognition/src/Result/ListCollectionsResponse.php @@ -15,12 +15,16 @@ class ListCollectionsResponse extends Result implements \IteratorAggregate { /** * An array of collection IDs. + * + * @var string[] */ private $collectionIds; /** * If the result is truncated, the response provides a `NextToken` that you can use in the subsequent request to fetch * the next set of collection IDs. + * + * @var string|null */ private $nextToken; @@ -28,6 +32,8 @@ class ListCollectionsResponse extends Result implements \IteratorAggregate * Version numbers of the face detection models associated with the collections in the array `CollectionIds`. For * example, the value of `FaceModelVersions[2]` is the version number for the face detection model used by the * collection in `CollectionId[2]`. + * + * @var string[] */ private $faceModelVersions; diff --git a/src/Service/Rekognition/src/Result/RecognizeCelebritiesResponse.php b/src/Service/Rekognition/src/Result/RecognizeCelebritiesResponse.php index 0ec1280c5..7a35aa0ab 100644 --- a/src/Service/Rekognition/src/Result/RecognizeCelebritiesResponse.php +++ b/src/Service/Rekognition/src/Result/RecognizeCelebritiesResponse.php @@ -21,11 +21,15 @@ class RecognizeCelebritiesResponse extends Result * Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an * image. Each celebrity object includes the following attributes: `Face`, `Confidence`, `Emotions`, `Landmarks`, * `Pose`, `Quality`, `Smile`, `Id`, `KnownGender`, `MatchConfidence`, `Name`, `Urls`. + * + * @var Celebrity[] */ private $celebrityFaces; /** * Details about each unrecognized face in the image. + * + * @var ComparedFace[] */ private $unrecognizedFaces; @@ -42,6 +46,8 @@ class RecognizeCelebritiesResponse extends Result * > `OrientationCorrection` is null. The `CelebrityFaces` and `UnrecognizedFaces` bounding box coordinates represent * > face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain * > Exif metadata. + * + * @var OrientationCorrection::*|null */ private $orientationCorrection; diff --git a/src/Service/Rekognition/src/Result/SearchFacesByImageResponse.php b/src/Service/Rekognition/src/Result/SearchFacesByImageResponse.php index e6262f553..bb8415285 100644 --- a/src/Service/Rekognition/src/Result/SearchFacesByImageResponse.php +++ b/src/Service/Rekognition/src/Result/SearchFacesByImageResponse.php @@ -12,21 +12,29 @@ class SearchFacesByImageResponse extends Result { /** * The bounding box around the face in the input image that Amazon Rekognition used for the search. + * + * @var BoundingBox|null */ private $searchedFaceBoundingBox; /** * The level of confidence that the `searchedFaceBoundingBox`, contains a face. + * + * @var float|null */ private $searchedFaceConfidence; /** * An array of faces that match the input face, along with the confidence in the match. + * + * @var FaceMatch[] */ private $faceMatches; /** * Version number of the face detection model associated with the input collection (`CollectionId`). + * + * @var string|null */ private $faceModelVersion; diff --git a/src/Service/Rekognition/src/ValueObject/AgeRange.php b/src/Service/Rekognition/src/ValueObject/AgeRange.php index 77ce735d9..5883eac64 100644 --- a/src/Service/Rekognition/src/ValueObject/AgeRange.php +++ b/src/Service/Rekognition/src/ValueObject/AgeRange.php @@ -13,11 +13,15 @@ final class AgeRange { /** * The lowest estimated age. + * + * @var int|null */ private $low; /** * The highest estimated age. + * + * @var int|null */ private $high; diff --git a/src/Service/Rekognition/src/ValueObject/Beard.php b/src/Service/Rekognition/src/ValueObject/Beard.php index 11a341ce2..8b7afc91f 100644 --- a/src/Service/Rekognition/src/ValueObject/Beard.php +++ b/src/Service/Rekognition/src/ValueObject/Beard.php @@ -9,11 +9,15 @@ final class Beard { /** * Boolean value that indicates whether the face has beard or not. + * + * @var bool|null */ private $value; /** * Level of confidence in the determination. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/BoundingBox.php b/src/Service/Rekognition/src/ValueObject/BoundingBox.php index 81ad52969..c5d7559d3 100644 --- a/src/Service/Rekognition/src/ValueObject/BoundingBox.php +++ b/src/Service/Rekognition/src/ValueObject/BoundingBox.php @@ -24,21 +24,29 @@ final class BoundingBox { /** * Width of the bounding box as a ratio of the overall image width. + * + * @var float|null */ private $width; /** * Height of the bounding box as a ratio of the overall image height. + * + * @var float|null */ private $height; /** * Left coordinate of the bounding box as a ratio of overall image width. + * + * @var float|null */ private $left; /** * Top coordinate of the bounding box as a ratio of overall image height. + * + * @var float|null */ private $top; diff --git a/src/Service/Rekognition/src/ValueObject/Celebrity.php b/src/Service/Rekognition/src/ValueObject/Celebrity.php index 0d12ddba2..e3751992c 100644 --- a/src/Service/Rekognition/src/ValueObject/Celebrity.php +++ b/src/Service/Rekognition/src/ValueObject/Celebrity.php @@ -10,29 +10,42 @@ final class Celebrity /** * An array of URLs pointing to additional information about the celebrity. If there is no additional information about * the celebrity, this list is empty. + * + * @var string[]|null */ private $urls; /** * The name of the celebrity. + * + * @var string|null */ private $name; /** * A unique identifier for the celebrity. + * + * @var string|null */ private $id; /** * Provides information about the celebrity's face, such as its location on the image. + * + * @var ComparedFace|null */ private $face; /** * The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity. + * + * @var float|null */ private $matchConfidence; + /** + * @var KnownGender|null + */ private $knownGender; /** diff --git a/src/Service/Rekognition/src/ValueObject/ComparedFace.php b/src/Service/Rekognition/src/ValueObject/ComparedFace.php index 3f3ad3401..7c81492dc 100644 --- a/src/Service/Rekognition/src/ValueObject/ComparedFace.php +++ b/src/Service/Rekognition/src/ValueObject/ComparedFace.php @@ -9,37 +9,51 @@ final class ComparedFace { /** * Bounding box of the face. + * + * @var BoundingBox|null */ private $boundingBox; /** * Level of confidence that what the bounding box contains is a face. + * + * @var float|null */ private $confidence; /** * An array of facial landmarks. + * + * @var Landmark[]|null */ private $landmarks; /** * Indicates the pose of the face as determined by its pitch, roll, and yaw. + * + * @var Pose|null */ private $pose; /** * Identifies face image brightness and sharpness. + * + * @var ImageQuality|null */ private $quality; /** * The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values * include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear". + * + * @var Emotion[]|null */ private $emotions; /** * Indicates whether or not the face is smiling, and the confidence level in the determination. + * + * @var Smile|null */ private $smile; diff --git a/src/Service/Rekognition/src/ValueObject/Emotion.php b/src/Service/Rekognition/src/ValueObject/Emotion.php index c5ac94a36..bf05f471a 100644 --- a/src/Service/Rekognition/src/ValueObject/Emotion.php +++ b/src/Service/Rekognition/src/ValueObject/Emotion.php @@ -14,11 +14,15 @@ final class Emotion { /** * Type of emotion detected. + * + * @var EmotionName::*|null */ private $type; /** * Level of confidence in the determination. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/EyeDirection.php b/src/Service/Rekognition/src/ValueObject/EyeDirection.php index 10ba3d136..098b6f5ae 100644 --- a/src/Service/Rekognition/src/ValueObject/EyeDirection.php +++ b/src/Service/Rekognition/src/ValueObject/EyeDirection.php @@ -9,16 +9,22 @@ final class EyeDirection { /** * Value representing eye direction on the yaw axis. + * + * @var float|null */ private $yaw; /** * Value representing eye direction on the pitch axis. + * + * @var float|null */ private $pitch; /** * The confidence that the service has in its predicted eye direction. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/EyeOpen.php b/src/Service/Rekognition/src/ValueObject/EyeOpen.php index d51e63a65..d5eb0fd12 100644 --- a/src/Service/Rekognition/src/ValueObject/EyeOpen.php +++ b/src/Service/Rekognition/src/ValueObject/EyeOpen.php @@ -9,11 +9,15 @@ final class EyeOpen { /** * Boolean value that indicates whether the eyes on the face are open. + * + * @var bool|null */ private $value; /** * Level of confidence in the determination. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/Eyeglasses.php b/src/Service/Rekognition/src/ValueObject/Eyeglasses.php index a0b94a87d..bf0c23b42 100644 --- a/src/Service/Rekognition/src/ValueObject/Eyeglasses.php +++ b/src/Service/Rekognition/src/ValueObject/Eyeglasses.php @@ -9,11 +9,15 @@ final class Eyeglasses { /** * Boolean value that indicates whether the face is wearing eye glasses or not. + * + * @var bool|null */ private $value; /** * Level of confidence in the determination. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/Face.php b/src/Service/Rekognition/src/ValueObject/Face.php index d5ca17f42..c22c5cb6a 100644 --- a/src/Service/Rekognition/src/ValueObject/Face.php +++ b/src/Service/Rekognition/src/ValueObject/Face.php @@ -10,36 +10,50 @@ final class Face { /** * Unique identifier that Amazon Rekognition assigns to the face. + * + * @var string|null */ private $faceId; /** * Bounding box of the face. + * + * @var BoundingBox|null */ private $boundingBox; /** * Unique identifier that Amazon Rekognition assigns to the input image. + * + * @var string|null */ private $imageId; /** * Identifier that you assign to all the faces in the input image. + * + * @var string|null */ private $externalImageId; /** * Confidence level that the bounding box contains a face (and not a different object such as a tree). + * + * @var float|null */ private $confidence; /** * The version of the face detect and storage model that was used when indexing the face vector. + * + * @var string|null */ private $indexFacesModelVersion; /** * Unique identifier assigned to the user. + * + * @var string|null */ private $userId; diff --git a/src/Service/Rekognition/src/ValueObject/FaceDetail.php b/src/Service/Rekognition/src/ValueObject/FaceDetail.php index 33a050e30..bbf0486ec 100644 --- a/src/Service/Rekognition/src/ValueObject/FaceDetail.php +++ b/src/Service/Rekognition/src/ValueObject/FaceDetail.php @@ -25,52 +25,72 @@ final class FaceDetail { /** * Bounding box of the face. Default attribute. + * + * @var BoundingBox|null */ private $boundingBox; /** * The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the * highest estimated age. + * + * @var AgeRange|null */ private $ageRange; /** * Indicates whether or not the face is smiling, and the confidence level in the determination. + * + * @var Smile|null */ private $smile; /** * Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination. + * + * @var Eyeglasses|null */ private $eyeglasses; /** * Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination. + * + * @var Sunglasses|null */ private $sunglasses; /** * The predicted gender of a detected face. + * + * @var Gender|null */ private $gender; /** * Indicates whether or not the face has a beard, and the confidence level in the determination. + * + * @var Beard|null */ private $beard; /** * Indicates whether or not the face has a mustache, and the confidence level in the determination. + * + * @var Mustache|null */ private $mustache; /** * Indicates whether or not the eyes on the face are open, and the confidence level in the determination. + * + * @var EyeOpen|null */ private $eyesOpen; /** * Indicates whether or not the mouth on the face is open, and the confidence level in the determination. + * + * @var MouthOpen|null */ private $mouthOpen; @@ -79,27 +99,37 @@ final class FaceDetail * making a determination of the physical appearance of a person's face. It is not a determination of the person’s * internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face * might not be sad emotionally. + * + * @var Emotion[]|null */ private $emotions; /** * Indicates the location of landmarks on the face. Default attribute. + * + * @var Landmark[]|null */ private $landmarks; /** * Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute. + * + * @var Pose|null */ private $pose; /** * Identifies image brightness and sharpness. Default attribute. + * + * @var ImageQuality|null */ private $quality; /** * Confidence level that the bounding box contains a face (and not a different object such as a tree). Default * attribute. + * + * @var float|null */ private $confidence; @@ -108,11 +138,15 @@ final class FaceDetail * partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. * `FaceOccluded` should return "false" with a high confidence score if common occurrences that do not impact face * verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others. + * + * @var FaceOccluded|null */ private $faceOccluded; /** * Indicates the direction the eyes are gazing in, as defined by pitch and yaw. + * + * @var EyeDirection|null */ private $eyeDirection; diff --git a/src/Service/Rekognition/src/ValueObject/FaceMatch.php b/src/Service/Rekognition/src/ValueObject/FaceMatch.php index 68928ffcf..5938e378b 100644 --- a/src/Service/Rekognition/src/ValueObject/FaceMatch.php +++ b/src/Service/Rekognition/src/ValueObject/FaceMatch.php @@ -9,12 +9,16 @@ final class FaceMatch { /** * Confidence in the match of this face with the input face. + * + * @var float|null */ private $similarity; /** * Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID * that you assigned. + * + * @var Face|null */ private $face; diff --git a/src/Service/Rekognition/src/ValueObject/FaceOccluded.php b/src/Service/Rekognition/src/ValueObject/FaceOccluded.php index 65a8006f0..ecd989db2 100644 --- a/src/Service/Rekognition/src/ValueObject/FaceOccluded.php +++ b/src/Service/Rekognition/src/ValueObject/FaceOccluded.php @@ -17,11 +17,15 @@ final class FaceOccluded * True if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark * sunglasses, cell phones, hands, or other objects. False if common occurrences that do not impact face verification * are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others. + * + * @var bool|null */ private $value; /** * The confidence that the service has detected the presence of a face occlusion. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/FaceRecord.php b/src/Service/Rekognition/src/ValueObject/FaceRecord.php index 7c3bb62b4..c0d458682 100644 --- a/src/Service/Rekognition/src/ValueObject/FaceRecord.php +++ b/src/Service/Rekognition/src/ValueObject/FaceRecord.php @@ -11,11 +11,15 @@ final class FaceRecord /** * Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID * that you assigned. + * + * @var Face|null */ private $face; /** * Structure containing attributes of the face that the algorithm detected. + * + * @var FaceDetail|null */ private $faceDetail; diff --git a/src/Service/Rekognition/src/ValueObject/Gender.php b/src/Service/Rekognition/src/ValueObject/Gender.php index 1f232f047..840782700 100644 --- a/src/Service/Rekognition/src/ValueObject/Gender.php +++ b/src/Service/Rekognition/src/ValueObject/Gender.php @@ -23,11 +23,15 @@ final class Gender { /** * The predicted gender of the face. + * + * @var GenderType::*|null */ private $value; /** * Level of confidence in the prediction. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/HumanLoopActivationOutput.php b/src/Service/Rekognition/src/ValueObject/HumanLoopActivationOutput.php index 371921329..54286bbcb 100644 --- a/src/Service/Rekognition/src/ValueObject/HumanLoopActivationOutput.php +++ b/src/Service/Rekognition/src/ValueObject/HumanLoopActivationOutput.php @@ -10,16 +10,22 @@ final class HumanLoopActivationOutput { /** * The Amazon Resource Name (ARN) of the HumanLoop created. + * + * @var string|null */ private $humanLoopArn; /** * Shows if and why human review was needed. + * + * @var string[]|null */ private $humanLoopActivationReasons; /** * Shows the result of condition evaluations, including those conditions which activated a human review. + * + * @var string|null */ private $humanLoopActivationConditionsEvaluationResults; diff --git a/src/Service/Rekognition/src/ValueObject/HumanLoopConfig.php b/src/Service/Rekognition/src/ValueObject/HumanLoopConfig.php index 80db499b2..4b51a4dbe 100644 --- a/src/Service/Rekognition/src/ValueObject/HumanLoopConfig.php +++ b/src/Service/Rekognition/src/ValueObject/HumanLoopConfig.php @@ -12,6 +12,8 @@ final class HumanLoopConfig { /** * The name of the human review used for this image. This should be kept unique within a region. + * + * @var string */ private $humanLoopName; @@ -20,11 +22,15 @@ final class HumanLoopConfig * CreateFlowDefinition [^1] Operation. * * [^1]: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html + * + * @var string */ private $flowDefinitionArn; /** * Sets attributes of the input data. + * + * @var HumanLoopDataAttributes|null */ private $dataAttributes; diff --git a/src/Service/Rekognition/src/ValueObject/HumanLoopDataAttributes.php b/src/Service/Rekognition/src/ValueObject/HumanLoopDataAttributes.php index f4931602a..409adfb9d 100644 --- a/src/Service/Rekognition/src/ValueObject/HumanLoopDataAttributes.php +++ b/src/Service/Rekognition/src/ValueObject/HumanLoopDataAttributes.php @@ -13,6 +13,8 @@ final class HumanLoopDataAttributes { /** * Sets whether the input image is free of personally identifiable information. + * + * @var list|null */ private $contentClassifiers; diff --git a/src/Service/Rekognition/src/ValueObject/Image.php b/src/Service/Rekognition/src/ValueObject/Image.php index 74dc42d80..7167475fe 100644 --- a/src/Service/Rekognition/src/ValueObject/Image.php +++ b/src/Service/Rekognition/src/ValueObject/Image.php @@ -30,11 +30,15 @@ final class Image { /** * Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to `DetectCustomLabels` is 4MB. + * + * @var string|null */ private $bytes; /** * Identifies an S3 object as the image source. + * + * @var S3Object|null */ private $s3Object; diff --git a/src/Service/Rekognition/src/ValueObject/ImageQuality.php b/src/Service/Rekognition/src/ValueObject/ImageQuality.php index a30a7d098..c4d7b1696 100644 --- a/src/Service/Rekognition/src/ValueObject/ImageQuality.php +++ b/src/Service/Rekognition/src/ValueObject/ImageQuality.php @@ -10,12 +10,16 @@ final class ImageQuality /** * Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value * indicates a brighter face image. + * + * @var float|null */ private $brightness; /** * Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value * indicates a sharper face image. + * + * @var float|null */ private $sharpness; diff --git a/src/Service/Rekognition/src/ValueObject/KnownGender.php b/src/Service/Rekognition/src/ValueObject/KnownGender.php index 1266e184d..ba2d54f14 100644 --- a/src/Service/Rekognition/src/ValueObject/KnownGender.php +++ b/src/Service/Rekognition/src/ValueObject/KnownGender.php @@ -12,6 +12,8 @@ final class KnownGender { /** * A string value of the KnownGender info about the Celebrity. + * + * @var KnownGenderType::*|null */ private $type; diff --git a/src/Service/Rekognition/src/ValueObject/Landmark.php b/src/Service/Rekognition/src/ValueObject/Landmark.php index 3008203df..3af44aecd 100644 --- a/src/Service/Rekognition/src/ValueObject/Landmark.php +++ b/src/Service/Rekognition/src/ValueObject/Landmark.php @@ -11,6 +11,8 @@ final class Landmark { /** * Type of landmark. + * + * @var LandmarkType::*|null */ private $type; @@ -18,6 +20,8 @@ final class Landmark * The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from * the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at * 350 pixels, this value is 0.5. + * + * @var float|null */ private $x; @@ -25,6 +29,8 @@ final class Landmark * The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from * the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 * pixels, this value is 0.25. + * + * @var float|null */ private $y; diff --git a/src/Service/Rekognition/src/ValueObject/ModerationLabel.php b/src/Service/Rekognition/src/ValueObject/ModerationLabel.php index 79b49b822..f86fc7cbe 100644 --- a/src/Service/Rekognition/src/ValueObject/ModerationLabel.php +++ b/src/Service/Rekognition/src/ValueObject/ModerationLabel.php @@ -14,16 +14,22 @@ final class ModerationLabel * * If you don't specify the `MinConfidence` parameter in the call to `DetectModerationLabels`, the operation returns * labels with a confidence value greater than or equal to 50 percent. + * + * @var float|null */ private $confidence; /** * The label name for the type of unsafe content detected in the image. + * + * @var string|null */ private $name; /** * The name for the parent label. Labels at the top level of the hierarchy have the parent label `""`. + * + * @var string|null */ private $parentName; diff --git a/src/Service/Rekognition/src/ValueObject/MouthOpen.php b/src/Service/Rekognition/src/ValueObject/MouthOpen.php index 91012bc16..2f227f189 100644 --- a/src/Service/Rekognition/src/ValueObject/MouthOpen.php +++ b/src/Service/Rekognition/src/ValueObject/MouthOpen.php @@ -9,11 +9,15 @@ final class MouthOpen { /** * Boolean value that indicates whether the mouth on the face is open or not. + * + * @var bool|null */ private $value; /** * Level of confidence in the determination. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/Mustache.php b/src/Service/Rekognition/src/ValueObject/Mustache.php index 603912f07..d4c411928 100644 --- a/src/Service/Rekognition/src/ValueObject/Mustache.php +++ b/src/Service/Rekognition/src/ValueObject/Mustache.php @@ -9,11 +9,15 @@ final class Mustache { /** * Boolean value that indicates whether the face has mustache or not. + * + * @var bool|null */ private $value; /** * Level of confidence in the determination. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/Pose.php b/src/Service/Rekognition/src/ValueObject/Pose.php index 7106df44f..9ff6585df 100644 --- a/src/Service/Rekognition/src/ValueObject/Pose.php +++ b/src/Service/Rekognition/src/ValueObject/Pose.php @@ -9,16 +9,22 @@ final class Pose { /** * Value representing the face rotation on the roll axis. + * + * @var float|null */ private $roll; /** * Value representing the face rotation on the yaw axis. + * + * @var float|null */ private $yaw; /** * Value representing the face rotation on the pitch axis. + * + * @var float|null */ private $pitch; diff --git a/src/Service/Rekognition/src/ValueObject/S3Object.php b/src/Service/Rekognition/src/ValueObject/S3Object.php index f494487ff..bced96b92 100644 --- a/src/Service/Rekognition/src/ValueObject/S3Object.php +++ b/src/Service/Rekognition/src/ValueObject/S3Object.php @@ -15,16 +15,22 @@ final class S3Object { /** * Name of the S3 bucket. + * + * @var string|null */ private $bucket; /** * S3 object key name. + * + * @var string|null */ private $name; /** * If the bucket is versioning enabled, you can specify the object version. + * + * @var string|null */ private $version; diff --git a/src/Service/Rekognition/src/ValueObject/Smile.php b/src/Service/Rekognition/src/ValueObject/Smile.php index ccb3c2572..2b97b13a7 100644 --- a/src/Service/Rekognition/src/ValueObject/Smile.php +++ b/src/Service/Rekognition/src/ValueObject/Smile.php @@ -9,11 +9,15 @@ final class Smile { /** * Boolean value that indicates whether the face is smiling or not. + * + * @var bool|null */ private $value; /** * Level of confidence in the determination. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/Sunglasses.php b/src/Service/Rekognition/src/ValueObject/Sunglasses.php index 3ace585d7..3649e9fb5 100644 --- a/src/Service/Rekognition/src/ValueObject/Sunglasses.php +++ b/src/Service/Rekognition/src/ValueObject/Sunglasses.php @@ -9,11 +9,15 @@ final class Sunglasses { /** * Boolean value that indicates whether the face is wearing sunglasses or not. + * + * @var bool|null */ private $value; /** * Level of confidence in the determination. + * + * @var float|null */ private $confidence; diff --git a/src/Service/Rekognition/src/ValueObject/UnindexedFace.php b/src/Service/Rekognition/src/ValueObject/UnindexedFace.php index 566a328ac..d03d16046 100644 --- a/src/Service/Rekognition/src/ValueObject/UnindexedFace.php +++ b/src/Service/Rekognition/src/ValueObject/UnindexedFace.php @@ -21,11 +21,15 @@ final class UnindexedFace * - LOW_SHARPNESS - The image is too blurry. * - LOW_CONFIDENCE - The face was detected with a low confidence. * - SMALL_BOUNDING_BOX - The bounding box around the face is too small. + * + * @var list|null */ private $reasons; /** * The structure that contains attributes of a face that `IndexFaces`detected, but didn't index. + * + * @var FaceDetail|null */ private $faceDetail; diff --git a/src/Service/Route53/src/Exception/InvalidChangeBatchException.php b/src/Service/Route53/src/Exception/InvalidChangeBatchException.php index 52ffe2d79..a555c839a 100644 --- a/src/Service/Route53/src/Exception/InvalidChangeBatchException.php +++ b/src/Service/Route53/src/Exception/InvalidChangeBatchException.php @@ -11,6 +11,9 @@ */ final class InvalidChangeBatchException extends ClientException { + /** + * @var string[] + */ private $messages; /** diff --git a/src/Service/Route53/src/Result/ChangeResourceRecordSetsResponse.php b/src/Service/Route53/src/Result/ChangeResourceRecordSetsResponse.php index 2bd6970ee..781b9aa93 100644 --- a/src/Service/Route53/src/Result/ChangeResourceRecordSetsResponse.php +++ b/src/Service/Route53/src/Result/ChangeResourceRecordSetsResponse.php @@ -18,6 +18,8 @@ class ChangeResourceRecordSetsResponse extends Result * the change. * * [^1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html + * + * @var ChangeInfo */ private $changeInfo; diff --git a/src/Service/Route53/src/Result/CreateHostedZoneResponse.php b/src/Service/Route53/src/Result/CreateHostedZoneResponse.php index c562c7429..a3a28c726 100644 --- a/src/Service/Route53/src/Result/CreateHostedZoneResponse.php +++ b/src/Service/Route53/src/Result/CreateHostedZoneResponse.php @@ -18,26 +18,36 @@ class CreateHostedZoneResponse extends Result { /** * A complex type that contains general information about the hosted zone. + * + * @var HostedZone */ private $hostedZone; /** * A complex type that contains information about the `CreateHostedZone` request. + * + * @var ChangeInfo */ private $changeInfo; /** * A complex type that describes the name servers for this hosted zone. + * + * @var DelegationSet */ private $delegationSet; /** * A complex type that contains information about an Amazon VPC that you associated with this hosted zone. + * + * @var VPC|null */ private $vpc; /** * The unique URL representing the new hosted zone. + * + * @var string */ private $location; diff --git a/src/Service/Route53/src/Result/DeleteHostedZoneResponse.php b/src/Service/Route53/src/Result/DeleteHostedZoneResponse.php index 4a7e60f7d..84843639b 100644 --- a/src/Service/Route53/src/Result/DeleteHostedZoneResponse.php +++ b/src/Service/Route53/src/Result/DeleteHostedZoneResponse.php @@ -13,6 +13,8 @@ class DeleteHostedZoneResponse extends Result { /** * A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone. + * + * @var ChangeInfo */ private $changeInfo; diff --git a/src/Service/Route53/src/Result/ListHostedZonesByNameResponse.php b/src/Service/Route53/src/Result/ListHostedZonesByNameResponse.php index 9a0fbad37..479e04cb8 100644 --- a/src/Service/Route53/src/Result/ListHostedZonesByNameResponse.php +++ b/src/Service/Route53/src/Result/ListHostedZonesByNameResponse.php @@ -15,17 +15,23 @@ class ListHostedZonesByNameResponse extends Result { /** * A complex type that contains general information about the hosted zone. + * + * @var HostedZone[] */ private $hostedZones; /** * For the second and subsequent calls to `ListHostedZonesByName`, `DNSName` is the value that you specified for the * `dnsname` parameter in the request that produced the current response. + * + * @var string|null */ private $dnsName; /** * The ID that Amazon Route 53 assigned to the hosted zone when you created it. + * + * @var string|null */ private $hostedZoneId; @@ -33,6 +39,8 @@ class ListHostedZonesByNameResponse extends Result * A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get * the next group of `maxitems` hosted zones by calling `ListHostedZonesByName` again and specifying the values of * `NextDNSName` and `NextHostedZoneId` elements in the `dnsname` and `hostedzoneid` parameters. + * + * @var bool */ private $isTruncated; @@ -42,6 +50,8 @@ class ListHostedZonesByNameResponse extends Result * `NextHostedZoneId` in the `dnsname` and `hostedzoneid` parameters, respectively. * * This element is present only if `IsTruncated` is `true`. + * + * @var string|null */ private $nextDnsName; @@ -51,12 +61,16 @@ class ListHostedZonesByNameResponse extends Result * `NextHostedZoneId` in the `dnsname` and `hostedzoneid` parameters, respectively. * * This element is present only if `IsTruncated` is `true`. + * + * @var string|null */ private $nextHostedZoneId; /** * The value that you specified for the `maxitems` parameter in the call to `ListHostedZonesByName` that produced the * current response. + * + * @var string */ private $maxItems; diff --git a/src/Service/Route53/src/Result/ListHostedZonesResponse.php b/src/Service/Route53/src/Result/ListHostedZonesResponse.php index 39c45a7fb..a76d9642c 100644 --- a/src/Service/Route53/src/Result/ListHostedZonesResponse.php +++ b/src/Service/Route53/src/Result/ListHostedZonesResponse.php @@ -18,12 +18,16 @@ class ListHostedZonesResponse extends Result implements \IteratorAggregate { /** * A complex type that contains general information about the hosted zone. + * + * @var HostedZone[] */ private $hostedZones; /** * For the second and subsequent calls to `ListHostedZones`, `Marker` is the value that you specified for the `marker` * parameter in the request that produced the current response. + * + * @var string */ private $marker; @@ -31,6 +35,8 @@ class ListHostedZonesResponse extends Result implements \IteratorAggregate * A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more * hosted zones by submitting another `ListHostedZones` request and specifying the value of `NextMarker` in the `marker` * parameter. + * + * @var bool */ private $isTruncated; @@ -40,12 +46,16 @@ class ListHostedZonesResponse extends Result implements \IteratorAggregate * `marker` parameter. * * This element is present only if `IsTruncated` is `true`. + * + * @var string|null */ private $nextMarker; /** * The value that you specified for the `maxitems` parameter in the call to `ListHostedZones` that produced the current * response. + * + * @var string */ private $maxItems; diff --git a/src/Service/Route53/src/Result/ListResourceRecordSetsResponse.php b/src/Service/Route53/src/Result/ListResourceRecordSetsResponse.php index 4d71595a5..360c8b178 100644 --- a/src/Service/Route53/src/Result/ListResourceRecordSetsResponse.php +++ b/src/Service/Route53/src/Result/ListResourceRecordSetsResponse.php @@ -23,12 +23,16 @@ class ListResourceRecordSetsResponse extends Result implements \IteratorAggregat { /** * Information about multiple resource record sets. + * + * @var ResourceRecordSet[] */ private $resourceRecordSets; /** * A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can * make a follow-up pagination request by using the `NextRecordName` element. + * + * @var bool */ private $isTruncated; @@ -36,6 +40,8 @@ class ListResourceRecordSetsResponse extends Result implements \IteratorAggregat * If the results were truncated, the name of the next record in the list. * * This element is present only if `IsTruncated` is true. + * + * @var string|null */ private $nextRecordName; @@ -43,6 +49,8 @@ class ListResourceRecordSetsResponse extends Result implements \IteratorAggregat * If the results were truncated, the type of the next record in the list. * * This element is present only if `IsTruncated` is true. + * + * @var RRType::*|null */ private $nextRecordType; @@ -53,11 +61,15 @@ class ListResourceRecordSetsResponse extends Result implements \IteratorAggregat * For information about routing policies, see Choosing a Routing Policy [^1] in the *Amazon Route 53 Developer Guide*. * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html + * + * @var string|null */ private $nextRecordIdentifier; /** * The maximum number of records you requested. + * + * @var string */ private $maxItems; diff --git a/src/Service/Route53/src/ValueObject/AliasTarget.php b/src/Service/Route53/src/ValueObject/AliasTarget.php index 0c74531f7..62ec8dc50 100644 --- a/src/Service/Route53/src/ValueObject/AliasTarget.php +++ b/src/Service/Route53/src/ValueObject/AliasTarget.php @@ -89,6 +89,8 @@ final class AliasTarget * [^7]: http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html * [^8]: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html * [^9]: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints + * + * @var string */ private $hostedZoneId; @@ -210,6 +212,8 @@ final class AliasTarget * [^12]: https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html * [^13]: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints * [^14]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html + * + * @var string */ private $dnsName; @@ -270,6 +274,8 @@ final class AliasTarget * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting * [^2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html + * + * @var bool */ private $evaluateTargetHealth; diff --git a/src/Service/Route53/src/ValueObject/Change.php b/src/Service/Route53/src/ValueObject/Change.php index ac3214a7b..6dfc9dc81 100644 --- a/src/Service/Route53/src/ValueObject/Change.php +++ b/src/Service/Route53/src/ValueObject/Change.php @@ -25,11 +25,15 @@ final class Change * Route 53 updates it with the values in the request. * * [^1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicyInstance.html + * + * @var ChangeAction::* */ private $action; /** * Information about the resource record set to create, delete, or update. + * + * @var ResourceRecordSet */ private $resourceRecordSet; diff --git a/src/Service/Route53/src/ValueObject/ChangeBatch.php b/src/Service/Route53/src/ValueObject/ChangeBatch.php index 0e2b7f9cd..8642638ed 100644 --- a/src/Service/Route53/src/ValueObject/ChangeBatch.php +++ b/src/Service/Route53/src/ValueObject/ChangeBatch.php @@ -11,11 +11,15 @@ final class ChangeBatch { /** * *Optional:* Any comments you want to include about a change batch request. + * + * @var string|null */ private $comment; /** * Information about the changes to make to the record sets. + * + * @var Change[] */ private $changes; diff --git a/src/Service/Route53/src/ValueObject/ChangeInfo.php b/src/Service/Route53/src/ValueObject/ChangeInfo.php index ef60fb295..0092358a7 100644 --- a/src/Service/Route53/src/ValueObject/ChangeInfo.php +++ b/src/Service/Route53/src/ValueObject/ChangeInfo.php @@ -15,12 +15,16 @@ final class ChangeInfo * the change. * * [^1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html + * + * @var string */ private $id; /** * The current state of the request. `PENDING` indicates that this request has not yet been applied to all Amazon Route * 53 DNS servers. + * + * @var ChangeStatus::* */ private $status; @@ -29,11 +33,15 @@ final class ChangeInfo * For example, the value `2017-03-27T17:48:16.751Z` represents March 27, 2017 at 17:48:16.751 UTC. * * [^1]: https://en.wikipedia.org/wiki/ISO_8601 + * + * @var \DateTimeImmutable */ private $submittedAt; /** * A comment you can provide. + * + * @var string|null */ private $comment; diff --git a/src/Service/Route53/src/ValueObject/CidrRoutingConfig.php b/src/Service/Route53/src/ValueObject/CidrRoutingConfig.php index 8fc760f12..44ee81b80 100644 --- a/src/Service/Route53/src/ValueObject/CidrRoutingConfig.php +++ b/src/Service/Route53/src/ValueObject/CidrRoutingConfig.php @@ -15,11 +15,15 @@ final class CidrRoutingConfig { /** * The CIDR collection ID. + * + * @var string */ private $collectionId; /** * The CIDR collection location name. + * + * @var string */ private $locationName; diff --git a/src/Service/Route53/src/ValueObject/DelegationSet.php b/src/Service/Route53/src/ValueObject/DelegationSet.php index 2735da282..9c1328ad3 100644 --- a/src/Service/Route53/src/ValueObject/DelegationSet.php +++ b/src/Service/Route53/src/ValueObject/DelegationSet.php @@ -12,17 +12,23 @@ final class DelegationSet { /** * The ID that Amazon Route 53 assigns to a reusable delegation set. + * + * @var string|null */ private $id; /** * The value that you specified for `CallerReference` when you created the reusable delegation set. + * + * @var string|null */ private $callerReference; /** * A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation * set. + * + * @var string[] */ private $nameServers; diff --git a/src/Service/Route53/src/ValueObject/GeoLocation.php b/src/Service/Route53/src/ValueObject/GeoLocation.php index 9fae6e7b3..130ae501a 100644 --- a/src/Service/Route53/src/ValueObject/GeoLocation.php +++ b/src/Service/Route53/src/ValueObject/GeoLocation.php @@ -22,6 +22,8 @@ final class GeoLocation * * Constraint: Specifying `ContinentCode` with either `CountryCode` or `SubdivisionCode` returns an `InvalidInput` * error. + * + * @var string|null */ private $continentCode; @@ -31,6 +33,8 @@ final class GeoLocation * Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2 [^1]. * * [^1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 + * + * @var string|null */ private $countryCode; @@ -42,6 +46,8 @@ final class GeoLocation * If you specify `subdivisioncode`, you must also specify `US` for `CountryCode`. * * [^1]: https://pe.usps.com/text/pub28/28apb.htm + * + * @var string|null */ private $subdivisionCode; diff --git a/src/Service/Route53/src/ValueObject/HostedZone.php b/src/Service/Route53/src/ValueObject/HostedZone.php index a33a46dfd..c29b5f6e1 100644 --- a/src/Service/Route53/src/ValueObject/HostedZone.php +++ b/src/Service/Route53/src/ValueObject/HostedZone.php @@ -11,6 +11,8 @@ final class HostedZone { /** * The ID that Amazon Route 53 assigned to the hosted zone when you created it. + * + * @var string */ private $id; @@ -21,28 +23,38 @@ final class HostedZone * internationalized domain names, see CreateHostedZone [^1]. * * [^1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html + * + * @var string */ private $name; /** * The value that you specified for `CallerReference` when you created the hosted zone. + * + * @var string */ private $callerReference; /** * A complex type that includes the `Comment` and `PrivateZone` elements. If you omitted the `HostedZoneConfig` and * `Comment` elements from the request, the `Config` and `Comment` elements don't appear in the response. + * + * @var HostedZoneConfig|null */ private $config; /** * The number of resource record sets in the hosted zone. + * + * @var int|null */ private $resourceRecordSetCount; /** * If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is * created by another service, you can't edit or delete it using Route 53. + * + * @var LinkedService|null */ private $linkedService; diff --git a/src/Service/Route53/src/ValueObject/HostedZoneConfig.php b/src/Service/Route53/src/ValueObject/HostedZoneConfig.php index 43207ec2c..d865a2c3d 100644 --- a/src/Service/Route53/src/ValueObject/HostedZoneConfig.php +++ b/src/Service/Route53/src/ValueObject/HostedZoneConfig.php @@ -10,11 +10,15 @@ final class HostedZoneConfig { /** * Any comments that you want to include about the hosted zone. + * + * @var string|null */ private $comment; /** * A value that indicates whether this is a private hosted zone. + * + * @var bool|null */ private $privateZone; diff --git a/src/Service/Route53/src/ValueObject/LinkedService.php b/src/Service/Route53/src/ValueObject/LinkedService.php index 2dd16ac10..670fd3e3f 100644 --- a/src/Service/Route53/src/ValueObject/LinkedService.php +++ b/src/Service/Route53/src/ValueObject/LinkedService.php @@ -12,12 +12,16 @@ final class LinkedService /** * If the health check or hosted zone was created by another service, the service that created the resource. When a * resource is created by another service, you can't edit or delete it using Amazon Route 53. + * + * @var string|null */ private $servicePrincipal; /** * If the health check or hosted zone was created by another service, an optional description that can be provided by * the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. + * + * @var string|null */ private $description; diff --git a/src/Service/Route53/src/ValueObject/ResourceRecord.php b/src/Service/Route53/src/ValueObject/ResourceRecord.php index dfc33f509..0231e3060 100644 --- a/src/Service/Route53/src/ValueObject/ResourceRecord.php +++ b/src/Service/Route53/src/ValueObject/ResourceRecord.php @@ -21,6 +21,8 @@ final class ResourceRecord * > If you're creating an alias resource record set, omit `Value`. * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html + * + * @var string */ private $value; diff --git a/src/Service/Route53/src/ValueObject/ResourceRecordSet.php b/src/Service/Route53/src/ValueObject/ResourceRecordSet.php index b25d29ed5..75b701a08 100644 --- a/src/Service/Route53/src/ValueObject/ResourceRecordSet.php +++ b/src/Service/Route53/src/ValueObject/ResourceRecordSet.php @@ -42,6 +42,8 @@ final class ResourceRecordSet * label; for example, you can't specify `prod*.example.com`. * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html + * + * @var string */ private $name; @@ -87,6 +89,8 @@ final class ResourceRecordSet * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html * [^2]: http://tools.ietf.org/html/rfc7208#section-14.1 + * + * @var RRType::* */ private $type; @@ -99,6 +103,8 @@ final class ResourceRecordSet * For information about routing policies, see Choosing a Routing Policy [^1] in the *Amazon Route 53 Developer Guide*. * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html + * + * @var string|null */ private $setIdentifier; @@ -125,6 +131,8 @@ final class ResourceRecordSet * the *Amazon Route 53 Developer Guide*. * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html + * + * @var int|null */ private $weight; @@ -146,6 +154,8 @@ final class ResourceRecordSet * region with the best latency from among the regions that you create latency resource record sets for. * - You can't create non-latency resource record sets that have the same values for the `Name` and `Type` elements as * latency resource record sets. + * + * @var ResourceRecordSetRegion::*|null */ private $region; @@ -178,6 +188,8 @@ final class ResourceRecordSet * * You can't create non-geolocation resource record sets that have the same values for the `Name` and `Type` elements as * geolocation resource record sets. + * + * @var GeoLocation|null */ private $geoLocation; @@ -214,6 +226,8 @@ final class ResourceRecordSet * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html * [^2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html + * + * @var ResourceRecordSetFailover::*|null */ private $failover; @@ -235,6 +249,8 @@ final class ResourceRecordSet * the IP addresses in the response. * * You can't create multivalue answer alias records. + * + * @var bool|null */ private $multiValueAnswer; @@ -250,6 +266,8 @@ final class ResourceRecordSet * alias target is an ELB load balancer, we recommend that you specify a `TTL` of 60 seconds for all of the non-alias * weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load * balancers) will change the effect of the values that you specify for `Weight`. + * + * @var int|null */ private $ttl; @@ -257,6 +275,8 @@ final class ResourceRecordSet * Information about the resource records to act upon. * * > If you're creating an alias resource record set, omit `ResourceRecords`. + * + * @var ResourceRecord[]|null */ private $resourceRecords; @@ -272,6 +292,8 @@ final class ResourceRecordSet * a Private Hosted Zone [^1] in the *Amazon Route 53 Developer Guide*. * * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html + * + * @var AliasTarget|null */ private $aliasTarget; @@ -363,6 +385,8 @@ final class ResourceRecordSet * [^1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html * [^2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html * [^3]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html + * + * @var string|null */ private $healthCheckId; @@ -375,9 +399,14 @@ final class ResourceRecordSet * ! `DeleteTrafficPolicyInstance`. Route 53 will delete the resource record set automatically. If you delete the * ! resource record set by using `ChangeResourceRecordSets`, Route 53 doesn't automatically delete the traffic policy * ! instance, and you'll continue to be charged for it even though it's no longer in use. + * + * @var string|null */ private $trafficPolicyInstanceId; + /** + * @var CidrRoutingConfig|null + */ private $cidrRoutingConfig; /** diff --git a/src/Service/Route53/src/ValueObject/VPC.php b/src/Service/Route53/src/ValueObject/VPC.php index 7c26d56e7..cf77e0387 100644 --- a/src/Service/Route53/src/ValueObject/VPC.php +++ b/src/Service/Route53/src/ValueObject/VPC.php @@ -17,9 +17,14 @@ final class VPC { /** * (Private hosted zones only) The region that an Amazon VPC was created in. + * + * @var VPCRegion::*|null */ private $vpcRegion; + /** + * @var string|null + */ private $vpcId; /** diff --git a/src/Service/S3/src/Exception/InvalidObjectStateException.php b/src/Service/S3/src/Exception/InvalidObjectStateException.php index a5aa94e44..af2d39d33 100644 --- a/src/Service/S3/src/Exception/InvalidObjectStateException.php +++ b/src/Service/S3/src/Exception/InvalidObjectStateException.php @@ -12,8 +12,14 @@ */ final class InvalidObjectStateException extends ClientException { + /** + * @var StorageClass::*|null + */ private $storageClass; + /** + * @var IntelligentTieringAccessTier::*|null + */ private $accessTier; /** diff --git a/src/Service/S3/src/Result/AbortMultipartUploadOutput.php b/src/Service/S3/src/Result/AbortMultipartUploadOutput.php index 381c0aee3..efe26b296 100644 --- a/src/Service/S3/src/Result/AbortMultipartUploadOutput.php +++ b/src/Service/S3/src/Result/AbortMultipartUploadOutput.php @@ -8,6 +8,9 @@ class AbortMultipartUploadOutput extends Result { + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** diff --git a/src/Service/S3/src/Result/CompleteMultipartUploadOutput.php b/src/Service/S3/src/Result/CompleteMultipartUploadOutput.php index f846c00d4..c948580f3 100644 --- a/src/Service/S3/src/Result/CompleteMultipartUploadOutput.php +++ b/src/Service/S3/src/Result/CompleteMultipartUploadOutput.php @@ -11,6 +11,8 @@ class CompleteMultipartUploadOutput extends Result { /** * The URI that identifies the newly created object. + * + * @var string|null */ private $location; @@ -31,17 +33,23 @@ class CompleteMultipartUploadOutput extends Result * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html * [^2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + * + * @var string|null */ private $bucket; /** * The object key of the newly created object. + * + * @var string|null */ private $key; /** * If the object expiration is configured, this will contain the expiration date (`expiry-date`) and rule ID * (`rule-id`). The value of `rule-id` is URL-encoded. + * + * @var string|null */ private $expiration; @@ -53,6 +61,8 @@ class CompleteMultipartUploadOutput extends Result * is calculated, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html + * + * @var string|null */ private $etag; @@ -62,6 +72,8 @@ class CompleteMultipartUploadOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32; @@ -71,6 +83,8 @@ class CompleteMultipartUploadOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32C; @@ -80,6 +94,8 @@ class CompleteMultipartUploadOutput extends Result * calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha1; @@ -89,31 +105,44 @@ class CompleteMultipartUploadOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha256; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, `AES256`, `aws:kms`). + * + * @var ServerSideEncryption::*|null */ private $serverSideEncryption; /** * Version ID of the newly created object, in case the bucket has versioning turned on. + * + * @var string|null */ private $versionId; /** * If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was * used for the object. + * + * @var string|null */ private $sseKmsKeyId; /** * Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service * (KMS) keys (SSE-KMS). + * + * @var bool|null */ private $bucketKeyEnabled; + /** + * @var RequestCharged::*|null + */ private $requestCharged; public function getBucket(): ?string diff --git a/src/Service/S3/src/Result/CopyObjectOutput.php b/src/Service/S3/src/Result/CopyObjectOutput.php index 0af9758fd..e518f272b 100644 --- a/src/Service/S3/src/Result/CopyObjectOutput.php +++ b/src/Service/S3/src/Result/CopyObjectOutput.php @@ -12,60 +12,83 @@ class CopyObjectOutput extends Result { /** * Container for all response elements. + * + * @var CopyObjectResult|null */ private $copyObjectResult; /** * If the object expiration is configured, the response includes this header. + * + * @var string|null */ private $expiration; /** * Version of the copied object in the destination bucket. + * + * @var string|null */ private $copySourceVersionId; /** * Version ID of the newly created copy. + * + * @var string|null */ private $versionId; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, `AES256`, `aws:kms`, * `aws:kms:dsse`). + * + * @var ServerSideEncryption::*|null */ private $serverSideEncryption; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header confirming the encryption algorithm used. + * + * @var string|null */ private $sseCustomerAlgorithm; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header to provide round-trip message integrity verification of the customer-provided encryption key. + * + * @var string|null */ private $sseCustomerKeyMd5; /** * If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was * used for the object. + * + * @var string|null */ private $sseKmsKeyId; /** * If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. + * + * @var string|null */ private $sseKmsEncryptionContext; /** * Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service * (KMS) keys (SSE-KMS). + * + * @var bool|null */ private $bucketKeyEnabled; + /** + * @var RequestCharged::*|null + */ private $requestCharged; public function getBucketKeyEnabled(): ?bool diff --git a/src/Service/S3/src/Result/CreateBucketOutput.php b/src/Service/S3/src/Result/CreateBucketOutput.php index c180b4dcc..441d7a2bf 100644 --- a/src/Service/S3/src/Result/CreateBucketOutput.php +++ b/src/Service/S3/src/Result/CreateBucketOutput.php @@ -9,6 +9,8 @@ class CreateBucketOutput extends Result { /** * A forward slash followed by the name of the bucket. + * + * @var string|null */ private $location; diff --git a/src/Service/S3/src/Result/CreateMultipartUploadOutput.php b/src/Service/S3/src/Result/CreateMultipartUploadOutput.php index 5efe22a8b..2d4371a87 100644 --- a/src/Service/S3/src/Result/CreateMultipartUploadOutput.php +++ b/src/Service/S3/src/Result/CreateMultipartUploadOutput.php @@ -20,12 +20,16 @@ class CreateMultipartUploadOutput extends Result * that defines this action. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config + * + * @var \DateTimeImmutable|null */ private $abortDate; /** * This header is returned along with the `x-amz-abort-date` header. It identifies the applicable lifecycle * configuration rule that defines the action to abort incomplete multipart uploads. + * + * @var string|null */ private $abortRuleId; @@ -46,58 +50,81 @@ class CreateMultipartUploadOutput extends Result * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html * [^2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + * + * @var string|null */ private $bucket; /** * Object key for which the multipart upload was initiated. + * + * @var string|null */ private $key; /** * ID for the initiated multipart upload. + * + * @var string|null */ private $uploadId; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, `AES256`, `aws:kms`). + * + * @var ServerSideEncryption::*|null */ private $serverSideEncryption; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header confirming the encryption algorithm used. + * + * @var string|null */ private $sseCustomerAlgorithm; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header to provide round-trip message integrity verification of the customer-provided encryption key. + * + * @var string|null */ private $sseCustomerKeyMd5; /** * If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was * used for the object. + * + * @var string|null */ private $sseKmsKeyId; /** * If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. + * + * @var string|null */ private $sseKmsEncryptionContext; /** * Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service * (KMS) keys (SSE-KMS). + * + * @var bool|null */ private $bucketKeyEnabled; + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** * The algorithm that was used to create a checksum of the object. + * + * @var ChecksumAlgorithm::*|null */ private $checksumAlgorithm; diff --git a/src/Service/S3/src/Result/DeleteObjectOutput.php b/src/Service/S3/src/Result/DeleteObjectOutput.php index cd33aacc9..f689fc1bf 100644 --- a/src/Service/S3/src/Result/DeleteObjectOutput.php +++ b/src/Service/S3/src/Result/DeleteObjectOutput.php @@ -10,14 +10,21 @@ class DeleteObjectOutput extends Result { /** * Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. + * + * @var bool|null */ private $deleteMarker; /** * Returns the version ID of the delete marker created as a result of the DELETE operation. + * + * @var string|null */ private $versionId; + /** + * @var RequestCharged::*|null + */ private $requestCharged; public function getDeleteMarker(): ?bool diff --git a/src/Service/S3/src/Result/DeleteObjectTaggingOutput.php b/src/Service/S3/src/Result/DeleteObjectTaggingOutput.php index 312ad7b5c..9b115a2a5 100644 --- a/src/Service/S3/src/Result/DeleteObjectTaggingOutput.php +++ b/src/Service/S3/src/Result/DeleteObjectTaggingOutput.php @@ -9,6 +9,8 @@ class DeleteObjectTaggingOutput extends Result { /** * The versionId of the object the tag-set was removed from. + * + * @var string|null */ private $versionId; diff --git a/src/Service/S3/src/Result/DeleteObjectsOutput.php b/src/Service/S3/src/Result/DeleteObjectsOutput.php index 6f01434ca..a5988d4da 100644 --- a/src/Service/S3/src/Result/DeleteObjectsOutput.php +++ b/src/Service/S3/src/Result/DeleteObjectsOutput.php @@ -12,14 +12,21 @@ class DeleteObjectsOutput extends Result { /** * Container element for a successful delete. It identifies the object that was successfully deleted. + * + * @var DeletedObject[] */ private $deleted; + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** * Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it * encountered. + * + * @var Error[] */ private $errors; diff --git a/src/Service/S3/src/Result/GetBucketCorsOutput.php b/src/Service/S3/src/Result/GetBucketCorsOutput.php index c3d4eef3c..0c0f02ab6 100644 --- a/src/Service/S3/src/Result/GetBucketCorsOutput.php +++ b/src/Service/S3/src/Result/GetBucketCorsOutput.php @@ -11,6 +11,8 @@ class GetBucketCorsOutput extends Result /** * A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the * configuration. + * + * @var CORSRule[] */ private $corsRules; diff --git a/src/Service/S3/src/Result/GetBucketEncryptionOutput.php b/src/Service/S3/src/Result/GetBucketEncryptionOutput.php index b966742ce..ab48d8a70 100644 --- a/src/Service/S3/src/Result/GetBucketEncryptionOutput.php +++ b/src/Service/S3/src/Result/GetBucketEncryptionOutput.php @@ -10,6 +10,9 @@ class GetBucketEncryptionOutput extends Result { + /** + * @var ServerSideEncryptionConfiguration|null + */ private $serverSideEncryptionConfiguration; public function getServerSideEncryptionConfiguration(): ?ServerSideEncryptionConfiguration diff --git a/src/Service/S3/src/Result/GetObjectAclOutput.php b/src/Service/S3/src/Result/GetObjectAclOutput.php index 5f90e4ba7..2d58c6e4a 100644 --- a/src/Service/S3/src/Result/GetObjectAclOutput.php +++ b/src/Service/S3/src/Result/GetObjectAclOutput.php @@ -13,14 +13,21 @@ class GetObjectAclOutput extends Result { /** * Container for the bucket owner's display name and ID. + * + * @var Owner|null */ private $owner; /** * A list of grants. + * + * @var Grant[] */ private $grants; + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** diff --git a/src/Service/S3/src/Result/GetObjectOutput.php b/src/Service/S3/src/Result/GetObjectOutput.php index 17382725a..804e0d8fd 100644 --- a/src/Service/S3/src/Result/GetObjectOutput.php +++ b/src/Service/S3/src/Result/GetObjectOutput.php @@ -16,17 +16,23 @@ class GetObjectOutput extends Result { /** * Object data. + * + * @var ResultStream */ private $body; /** * Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header * does not appear in the response. + * + * @var bool|null */ private $deleteMarker; /** * Indicates that a range of bytes was specified. + * + * @var string|null */ private $acceptRanges; @@ -34,27 +40,37 @@ class GetObjectOutput extends Result * If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the * `expiry-date` and `rule-id` key-value pairs providing object expiration information. The value of the `rule-id` is * URL-encoded. + * + * @var string|null */ private $expiration; /** * Provides information about object restoration action and expiration time of the restored object copy. + * + * @var string|null */ private $restore; /** * Creation date of the object. + * + * @var \DateTimeImmutable|null */ private $lastModified; /** * Size of the body in bytes. + * + * @var int|null */ private $contentLength; /** * An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a * URL. + * + * @var string|null */ private $etag; @@ -64,6 +80,8 @@ class GetObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32; @@ -73,6 +91,8 @@ class GetObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32C; @@ -82,6 +102,8 @@ class GetObjectOutput extends Result * calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha1; @@ -91,6 +113,8 @@ class GetObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha256; @@ -98,129 +122,178 @@ class GetObjectOutput extends Result * This is set to the number of metadata entries not returned in `x-amz-meta` headers. This can happen if you create * metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you * can create metadata whose values are not legal HTTP headers. + * + * @var int|null */ private $missingMeta; /** * Version of the object. + * + * @var string|null */ private $versionId; /** * Specifies caching behavior along the request/reply chain. + * + * @var string|null */ private $cacheControl; /** * Specifies presentational information for the object. + * + * @var string|null */ private $contentDisposition; /** * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to * obtain the media-type referenced by the Content-Type header field. + * + * @var string|null */ private $contentEncoding; /** * The language the content is in. + * + * @var string|null */ private $contentLanguage; /** * The portion of the object returned in the response. + * + * @var string|null */ private $contentRange; /** * A standard MIME type describing the format of the object data. + * + * @var string|null */ private $contentType; /** * The date and time at which the object is no longer cacheable. + * + * @var \DateTimeImmutable|null */ private $expires; /** * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or * to an external URL. Amazon S3 stores the value of this header in the object metadata. + * + * @var string|null */ private $websiteRedirectLocation; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, `AES256`, `aws:kms`, * `aws:kms:dsse`). + * + * @var ServerSideEncryption::*|null */ private $serverSideEncryption; /** * A map of metadata to store with the object in S3. + * + * @var array */ private $metadata; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header confirming the encryption algorithm used. + * + * @var string|null */ private $sseCustomerAlgorithm; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header to provide round-trip message integrity verification of the customer-provided encryption key. + * + * @var string|null */ private $sseCustomerKeyMd5; /** * If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was * used for the object. + * + * @var string|null */ private $sseKmsKeyId; /** * Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys * (SSE-KMS). + * + * @var bool|null */ private $bucketKeyEnabled; /** * Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 * Standard storage class objects. + * + * @var StorageClass::*|null */ private $storageClass; + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** * Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication * rule. + * + * @var ReplicationStatus::*|null */ private $replicationStatus; /** * The count of parts this object has. This value is only returned if you specify `partNumber` in your request and the * object was uploaded as a multipart upload. + * + * @var int|null */ private $partsCount; /** * The number of tags, if any, on the object. + * + * @var int|null */ private $tagCount; /** * The Object Lock mode currently in place for this object. + * + * @var ObjectLockMode::*|null */ private $objectLockMode; /** * The date and time when this object's Object Lock will expire. + * + * @var \DateTimeImmutable|null */ private $objectLockRetainUntilDate; /** * Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an * object's legal hold status. + * + * @var ObjectLockLegalHoldStatus::*|null */ private $objectLockLegalHoldStatus; diff --git a/src/Service/S3/src/Result/GetObjectTaggingOutput.php b/src/Service/S3/src/Result/GetObjectTaggingOutput.php index c4e01aa4e..d868b8aaf 100644 --- a/src/Service/S3/src/Result/GetObjectTaggingOutput.php +++ b/src/Service/S3/src/Result/GetObjectTaggingOutput.php @@ -10,11 +10,15 @@ class GetObjectTaggingOutput extends Result { /** * The versionId of the object for which you got the tagging information. + * + * @var string|null */ private $versionId; /** * Contains the tag set. + * + * @var Tag[] */ private $tagSet; diff --git a/src/Service/S3/src/Result/HeadObjectOutput.php b/src/Service/S3/src/Result/HeadObjectOutput.php index 7d43ca225..a64464b33 100644 --- a/src/Service/S3/src/Result/HeadObjectOutput.php +++ b/src/Service/S3/src/Result/HeadObjectOutput.php @@ -17,11 +17,15 @@ class HeadObjectOutput extends Result /** * Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header * does not appear in the response. + * + * @var bool|null */ private $deleteMarker; /** * Indicates that a range of bytes was specified. + * + * @var string|null */ private $acceptRanges; @@ -29,6 +33,8 @@ class HeadObjectOutput extends Result * If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the * `expiry-date` and `rule-id` key-value pairs providing object expiration information. The value of the `rule-id` is * URL-encoded. + * + * @var string|null */ private $expiration; @@ -47,21 +53,29 @@ class HeadObjectOutput extends Result * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html * [^2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations + * + * @var string|null */ private $restore; /** * The archive state of the head object. + * + * @var ArchiveStatus::*|null */ private $archiveStatus; /** * Creation date of the object. + * + * @var \DateTimeImmutable|null */ private $lastModified; /** * Size of the body in bytes. + * + * @var int|null */ private $contentLength; @@ -71,6 +85,8 @@ class HeadObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32; @@ -80,6 +96,8 @@ class HeadObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32C; @@ -89,6 +107,8 @@ class HeadObjectOutput extends Result * calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha1; @@ -98,12 +118,16 @@ class HeadObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha256; /** * An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a * URL. + * + * @var string|null */ private $etag; @@ -111,83 +135,113 @@ class HeadObjectOutput extends Result * This is set to the number of metadata entries not returned in `x-amz-meta` headers. This can happen if you create * metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you * can create metadata whose values are not legal HTTP headers. + * + * @var int|null */ private $missingMeta; /** * Version of the object. + * + * @var string|null */ private $versionId; /** * Specifies caching behavior along the request/reply chain. + * + * @var string|null */ private $cacheControl; /** * Specifies presentational information for the object. + * + * @var string|null */ private $contentDisposition; /** * Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to * obtain the media-type referenced by the Content-Type header field. + * + * @var string|null */ private $contentEncoding; /** * The language the content is in. + * + * @var string|null */ private $contentLanguage; /** * A standard MIME type describing the format of the object data. + * + * @var string|null */ private $contentType; /** * The date and time at which the object is no longer cacheable. + * + * @var \DateTimeImmutable|null */ private $expires; /** * If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or * to an external URL. Amazon S3 stores the value of this header in the object metadata. + * + * @var string|null */ private $websiteRedirectLocation; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, `AES256`, `aws:kms`, * `aws:kms:dsse`). + * + * @var ServerSideEncryption::*|null */ private $serverSideEncryption; /** * A map of metadata to store with the object in S3. + * + * @var array */ private $metadata; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header confirming the encryption algorithm used. + * + * @var string|null */ private $sseCustomerAlgorithm; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header to provide round-trip message integrity verification of the customer-provided encryption key. + * + * @var string|null */ private $sseCustomerKeyMd5; /** * If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was * used for the object. + * + * @var string|null */ private $sseKmsKeyId; /** * Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys * (SSE-KMS). + * + * @var bool|null */ private $bucketKeyEnabled; @@ -198,9 +252,14 @@ class HeadObjectOutput extends Result * For more information, see Storage Classes [^1]. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html + * + * @var StorageClass::*|null */ private $storageClass; + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** @@ -230,12 +289,16 @@ class HeadObjectOutput extends Result * For more information, see Replication [^1]. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html + * + * @var ReplicationStatus::*|null */ private $replicationStatus; /** * The count of parts this object has. This value is only returned if you specify `partNumber` in your request and the * object was uploaded as a multipart upload. + * + * @var int|null */ private $partsCount; @@ -244,12 +307,16 @@ class HeadObjectOutput extends Result * `s3:GetObjectRetention` permission. For more information about S3 Object Lock, see Object Lock [^1]. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html + * + * @var ObjectLockMode::*|null */ private $objectLockMode; /** * The date and time when the Object Lock retention period expires. This header is only returned if the requester has * the `s3:GetObjectRetention` permission. + * + * @var \DateTimeImmutable|null */ private $objectLockRetainUntilDate; @@ -259,6 +326,8 @@ class HeadObjectOutput extends Result * a legal hold applied. For more information about S3 Object Lock, see Object Lock [^1]. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html + * + * @var ObjectLockLegalHoldStatus::*|null */ private $objectLockLegalHoldStatus; diff --git a/src/Service/S3/src/Result/ListBucketsOutput.php b/src/Service/S3/src/Result/ListBucketsOutput.php index 289c591b4..a9126636d 100644 --- a/src/Service/S3/src/Result/ListBucketsOutput.php +++ b/src/Service/S3/src/Result/ListBucketsOutput.php @@ -14,11 +14,15 @@ class ListBucketsOutput extends Result implements \IteratorAggregate { /** * The list of buckets owned by the requester. + * + * @var Bucket[] */ private $buckets; /** * The owner of the buckets listed. + * + * @var Owner|null */ private $owner; diff --git a/src/Service/S3/src/Result/ListMultipartUploadsOutput.php b/src/Service/S3/src/Result/ListMultipartUploadsOutput.php index f7d491a1e..80d8a7794 100644 --- a/src/Service/S3/src/Result/ListMultipartUploadsOutput.php +++ b/src/Service/S3/src/Result/ListMultipartUploadsOutput.php @@ -22,45 +22,61 @@ class ListMultipartUploadsOutput extends Result implements \IteratorAggregate /** * The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access * point alias if used. + * + * @var string|null */ private $bucket; /** * The key at or after which the listing began. + * + * @var string|null */ private $keyMarker; /** * Upload ID after which listing began. + * + * @var string|null */ private $uploadIdMarker; /** * When a list is truncated, this element specifies the value that should be used for the key-marker request parameter * in a subsequent request. + * + * @var string|null */ private $nextKeyMarker; /** * When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys * starting with the specified prefix. + * + * @var string|null */ private $prefix; /** * Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element * is absent from the response. + * + * @var string|null */ private $delimiter; /** * When a list is truncated, this element specifies the value that should be used for the `upload-id-marker` request * parameter in a subsequent request. + * + * @var string|null */ private $nextUploadIdMarker; /** * Maximum number of multipart uploads that could have been included in the response. + * + * @var int|null */ private $maxUploads; @@ -68,18 +84,24 @@ class ListMultipartUploadsOutput extends Result implements \IteratorAggregate * Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was * truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max * uploads. + * + * @var bool|null */ private $isTruncated; /** * Container for elements related to a particular multipart upload. A response can contain zero or more `Upload` * elements. + * + * @var MultipartUpload[] */ private $uploads; /** * If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter * in a `CommonPrefixes` element. The distinct key prefixes are returned in the `Prefix` child element. + * + * @var CommonPrefix[] */ private $commonPrefixes; @@ -90,9 +112,14 @@ class ListMultipartUploadsOutput extends Result implements \IteratorAggregate * encoded key name values in the following response elements: * * `Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`. + * + * @var EncodingType::*|null */ private $encodingType; + /** + * @var RequestCharged::*|null + */ private $requestCharged; public function getBucket(): ?string diff --git a/src/Service/S3/src/Result/ListObjectsV2Output.php b/src/Service/S3/src/Result/ListObjectsV2Output.php index ce72bc070..d03f77262 100644 --- a/src/Service/S3/src/Result/ListObjectsV2Output.php +++ b/src/Service/S3/src/Result/ListObjectsV2Output.php @@ -22,11 +22,15 @@ class ListObjectsV2Output extends Result implements \IteratorAggregate /** * Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of * results exceeds that specified by MaxKeys, all of the results might not be returned. + * + * @var bool|null */ private $isTruncated; /** * Metadata about each object returned. + * + * @var AwsObject[] */ private $contents; @@ -46,11 +50,15 @@ class ListObjectsV2Output extends Result implements \IteratorAggregate * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html * [^2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + * + * @var string|null */ private $name; /** * Keys that begin with the indicated prefix. + * + * @var string|null */ private $prefix; @@ -58,12 +66,16 @@ class ListObjectsV2Output extends Result implements \IteratorAggregate * Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up * into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the * response. Each rolled-up result counts as only one return against the `MaxKeys` value. + * + * @var string|null */ private $delimiter; /** * Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The * response might contain fewer keys but will never contain more. + * + * @var int|null */ private $maxKeys; @@ -81,6 +93,8 @@ class ListObjectsV2Output extends Result implements \IteratorAggregate * For example, if the prefix is `notes/` and the delimiter is a slash (`/`) as in `notes/summer/july`, the common * prefix is `notes/summer/`. All of the keys that roll up into a common prefix count as a single return when * calculating the number of returns. + * + * @var CommonPrefix[] */ private $commonPrefixes; @@ -91,17 +105,23 @@ class ListObjectsV2Output extends Result implements \IteratorAggregate * encoded key name values in the following response elements: * * `Delimiter, Prefix, Key,` and `StartAfter`. + * + * @var EncodingType::*|null */ private $encodingType; /** * KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the * `MaxKeys` field. Say you ask for 50 keys, your result will include 50 keys or fewer. + * + * @var int|null */ private $keyCount; /** * If ContinuationToken was sent with the request, it is included in the response. + * + * @var string|null */ private $continuationToken; @@ -109,14 +129,21 @@ class ListObjectsV2Output extends Result implements \IteratorAggregate * `NextContinuationToken` is sent when `isTruncated` is true, which means there are more keys in the bucket that can be * listed. The next list requests to Amazon S3 can be continued with this `NextContinuationToken`. * `NextContinuationToken` is obfuscated and is not a real key. + * + * @var string|null */ private $nextContinuationToken; /** * If StartAfter was sent with the request, it is included in the response. + * + * @var string|null */ private $startAfter; + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** diff --git a/src/Service/S3/src/Result/ListPartsOutput.php b/src/Service/S3/src/Result/ListPartsOutput.php index f42c99ff0..e3f237ff0 100644 --- a/src/Service/S3/src/Result/ListPartsOutput.php +++ b/src/Service/S3/src/Result/ListPartsOutput.php @@ -29,56 +29,76 @@ class ListPartsOutput extends Result implements \IteratorAggregate * configuration rule that defines this action. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config + * + * @var \DateTimeImmutable|null */ private $abortDate; /** * This header is returned along with the `x-amz-abort-date` header. It identifies applicable lifecycle configuration * rule that defines the action to abort incomplete multipart uploads. + * + * @var string|null */ private $abortRuleId; /** * The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access * point alias if used. + * + * @var string|null */ private $bucket; /** * Object key for which the multipart upload was initiated. + * + * @var string|null */ private $key; /** * Upload ID identifying the multipart upload whose parts are being listed. + * + * @var string|null */ private $uploadId; /** * When a list is truncated, this element specifies the last part in the list, as well as the value to use for the * part-number-marker request parameter in a subsequent request. + * + * @var int|null */ private $partNumberMarker; /** * When a list is truncated, this element specifies the last part in the list, as well as the value to use for the * part-number-marker request parameter in a subsequent request. + * + * @var int|null */ private $nextPartNumberMarker; /** * Maximum number of parts that were allowed in the response. + * + * @var int|null */ private $maxParts; /** * Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list * can be truncated if the number of parts exceeds the limit returned in the MaxParts element. + * + * @var bool|null */ private $isTruncated; /** * Container for elements related to a particular part. A response can contain zero or more `Part` elements. + * + * @var Part[] */ private $parts; @@ -86,24 +106,35 @@ class ListPartsOutput extends Result implements \IteratorAggregate * Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services * account, this element provides the same information as the `Owner` element. If the initiator is an IAM User, this * element provides the user ARN and display name. + * + * @var Initiator|null */ private $initiator; /** * Container element that identifies the object owner, after the object is created. If multipart upload is initiated by * an IAM user, this element provides the parent account ID and display name. + * + * @var Owner|null */ private $owner; /** * Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object. + * + * @var StorageClass::*|null */ private $storageClass; + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** * The algorithm that was used to create a checksum of the object. + * + * @var ChecksumAlgorithm::*|null */ private $checksumAlgorithm; diff --git a/src/Service/S3/src/Result/PutObjectAclOutput.php b/src/Service/S3/src/Result/PutObjectAclOutput.php index 90764986c..99718958b 100644 --- a/src/Service/S3/src/Result/PutObjectAclOutput.php +++ b/src/Service/S3/src/Result/PutObjectAclOutput.php @@ -8,6 +8,9 @@ class PutObjectAclOutput extends Result { + /** + * @var RequestCharged::*|null + */ private $requestCharged; /** diff --git a/src/Service/S3/src/Result/PutObjectOutput.php b/src/Service/S3/src/Result/PutObjectOutput.php index 99e89207a..7ffc03fa3 100644 --- a/src/Service/S3/src/Result/PutObjectOutput.php +++ b/src/Service/S3/src/Result/PutObjectOutput.php @@ -15,11 +15,15 @@ class PutObjectOutput extends Result * The value of the `rule-id` is URL-encoded. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html + * + * @var string|null */ private $expiration; /** * Entity tag for the uploaded object. + * + * @var string|null */ private $etag; @@ -29,6 +33,8 @@ class PutObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32; @@ -38,6 +44,8 @@ class PutObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32C; @@ -47,6 +55,8 @@ class PutObjectOutput extends Result * calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha1; @@ -56,35 +66,47 @@ class PutObjectOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha256; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, `AES256`, `aws:kms`, * `aws:kms:dsse`). + * + * @var ServerSideEncryption::*|null */ private $serverSideEncryption; /** * Version of the object. + * + * @var string|null */ private $versionId; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header confirming the encryption algorithm used. + * + * @var string|null */ private $sseCustomerAlgorithm; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header to provide round-trip message integrity verification of the customer-provided encryption key. + * + * @var string|null */ private $sseCustomerKeyMd5; /** * If `x-amz-server-side-encryption` has a valid value of `aws:kms` or `aws:kms:dsse`, this header specifies the ID of * the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object. + * + * @var string|null */ private $sseKmsKeyId; @@ -93,15 +115,22 @@ class PutObjectOutput extends Result * header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is * stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future `GetObject` or * `CopyObject` operations on this object. + * + * @var string|null */ private $sseKmsEncryptionContext; /** * Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service * (KMS) keys (SSE-KMS). + * + * @var bool|null */ private $bucketKeyEnabled; + /** + * @var RequestCharged::*|null + */ private $requestCharged; public function getBucketKeyEnabled(): ?bool diff --git a/src/Service/S3/src/Result/PutObjectTaggingOutput.php b/src/Service/S3/src/Result/PutObjectTaggingOutput.php index 17f25530e..a0cedbab9 100644 --- a/src/Service/S3/src/Result/PutObjectTaggingOutput.php +++ b/src/Service/S3/src/Result/PutObjectTaggingOutput.php @@ -9,6 +9,8 @@ class PutObjectTaggingOutput extends Result { /** * The versionId of the object the tag-set was added to. + * + * @var string|null */ private $versionId; diff --git a/src/Service/S3/src/Result/UploadPartOutput.php b/src/Service/S3/src/Result/UploadPartOutput.php index 2b69f96f7..25dc3f112 100644 --- a/src/Service/S3/src/Result/UploadPartOutput.php +++ b/src/Service/S3/src/Result/UploadPartOutput.php @@ -11,11 +11,15 @@ class UploadPartOutput extends Result { /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, `AES256`, `aws:kms`). + * + * @var ServerSideEncryption::*|null */ private $serverSideEncryption; /** * Entity tag for the uploaded object. + * + * @var string|null */ private $etag; @@ -25,6 +29,8 @@ class UploadPartOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32; @@ -34,6 +40,8 @@ class UploadPartOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32C; @@ -43,6 +51,8 @@ class UploadPartOutput extends Result * calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha1; @@ -52,33 +62,46 @@ class UploadPartOutput extends Result * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha256; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header confirming the encryption algorithm used. + * + * @var string|null */ private $sseCustomerAlgorithm; /** * If server-side encryption with a customer-provided encryption key was requested, the response will include this * header to provide round-trip message integrity verification of the customer-provided encryption key. + * + * @var string|null */ private $sseCustomerKeyMd5; /** * If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key was used * for the object. + * + * @var string|null */ private $sseKmsKeyId; /** * Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service * (KMS) keys (SSE-KMS). + * + * @var bool|null */ private $bucketKeyEnabled; + /** + * @var RequestCharged::*|null + */ private $requestCharged; public function getBucketKeyEnabled(): ?bool diff --git a/src/Service/S3/src/ValueObject/AccessControlPolicy.php b/src/Service/S3/src/ValueObject/AccessControlPolicy.php index a30dcc527..117ad9f21 100644 --- a/src/Service/S3/src/ValueObject/AccessControlPolicy.php +++ b/src/Service/S3/src/ValueObject/AccessControlPolicy.php @@ -9,11 +9,15 @@ final class AccessControlPolicy { /** * A list of grants. + * + * @var Grant[]|null */ private $grants; /** * Container for the bucket owner's display name and ID. + * + * @var Owner|null */ private $owner; diff --git a/src/Service/S3/src/ValueObject/AwsObject.php b/src/Service/S3/src/ValueObject/AwsObject.php index ab7e10cb8..d331a8e65 100644 --- a/src/Service/S3/src/ValueObject/AwsObject.php +++ b/src/Service/S3/src/ValueObject/AwsObject.php @@ -12,11 +12,15 @@ final class AwsObject { /** * The name that you assign to an object. You use the object key to retrieve the object. + * + * @var string|null */ private $key; /** * Creation date of the object. + * + * @var \DateTimeImmutable|null */ private $lastModified; @@ -32,26 +36,36 @@ final class AwsObject * - If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, * regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management * Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest. + * + * @var string|null */ private $etag; /** * The algorithm that was used to create a checksum of the object. + * + * @var list|null */ private $checksumAlgorithm; /** * Size in bytes of the object. + * + * @var int|null */ private $size; /** * The class of storage used to store the object. + * + * @var ObjectStorageClass::*|null */ private $storageClass; /** * The owner of the object. + * + * @var Owner|null */ private $owner; diff --git a/src/Service/S3/src/ValueObject/Bucket.php b/src/Service/S3/src/ValueObject/Bucket.php index 7e661e115..1e3800e66 100644 --- a/src/Service/S3/src/ValueObject/Bucket.php +++ b/src/Service/S3/src/ValueObject/Bucket.php @@ -10,12 +10,16 @@ final class Bucket { /** * The name of the bucket. + * + * @var string|null */ private $name; /** * Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket * policy. + * + * @var \DateTimeImmutable|null */ private $creationDate; diff --git a/src/Service/S3/src/ValueObject/CORSConfiguration.php b/src/Service/S3/src/ValueObject/CORSConfiguration.php index 39a8c57cc..7d7e30014 100644 --- a/src/Service/S3/src/ValueObject/CORSConfiguration.php +++ b/src/Service/S3/src/ValueObject/CORSConfiguration.php @@ -15,6 +15,8 @@ final class CORSConfiguration /** * A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the * configuration. + * + * @var CORSRule[] */ private $corsRules; diff --git a/src/Service/S3/src/ValueObject/CORSRule.php b/src/Service/S3/src/ValueObject/CORSRule.php index 1e14a3f73..161030cbc 100644 --- a/src/Service/S3/src/ValueObject/CORSRule.php +++ b/src/Service/S3/src/ValueObject/CORSRule.php @@ -11,6 +11,8 @@ final class CORSRule { /** * Unique identifier for the rule. The value cannot be longer than 255 characters. + * + * @var string|null */ private $id; @@ -18,27 +20,37 @@ final class CORSRule * Headers that are specified in the `Access-Control-Request-Headers` header. These headers are allowed in a preflight * OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are * allowed. + * + * @var string[]|null */ private $allowedHeaders; /** * An HTTP method that you allow the origin to execute. Valid values are `GET`, `PUT`, `HEAD`, `POST`, and `DELETE`. + * + * @var string[] */ private $allowedMethods; /** * One or more origins you want customers to be able to access the bucket from. + * + * @var string[] */ private $allowedOrigins; /** * One or more headers in the response that you want customers to be able to access from their applications (for * example, from a JavaScript `XMLHttpRequest` object). + * + * @var string[]|null */ private $exposeHeaders; /** * The time in seconds that your browser is to cache the preflight response for the specified resource. + * + * @var int|null */ private $maxAgeSeconds; diff --git a/src/Service/S3/src/ValueObject/CommonPrefix.php b/src/Service/S3/src/ValueObject/CommonPrefix.php index 91af8ae55..ca0256337 100644 --- a/src/Service/S3/src/ValueObject/CommonPrefix.php +++ b/src/Service/S3/src/ValueObject/CommonPrefix.php @@ -11,6 +11,8 @@ final class CommonPrefix { /** * Container for the specified common prefix. + * + * @var string|null */ private $prefix; diff --git a/src/Service/S3/src/ValueObject/CompletedMultipartUpload.php b/src/Service/S3/src/ValueObject/CompletedMultipartUpload.php index 27a5f9210..44e088101 100644 --- a/src/Service/S3/src/ValueObject/CompletedMultipartUpload.php +++ b/src/Service/S3/src/ValueObject/CompletedMultipartUpload.php @@ -11,6 +11,8 @@ final class CompletedMultipartUpload * Array of CompletedPart data types. * * If you do not supply a valid `Part` with your request, the service sends back an HTTP 400 response. + * + * @var CompletedPart[]|null */ private $parts; diff --git a/src/Service/S3/src/ValueObject/CompletedPart.php b/src/Service/S3/src/ValueObject/CompletedPart.php index 8822446cd..3e13e27e5 100644 --- a/src/Service/S3/src/ValueObject/CompletedPart.php +++ b/src/Service/S3/src/ValueObject/CompletedPart.php @@ -9,6 +9,8 @@ final class CompletedPart { /** * Entity tag returned when the part was uploaded. + * + * @var string|null */ private $etag; @@ -18,6 +20,8 @@ final class CompletedPart * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32; @@ -27,6 +31,8 @@ final class CompletedPart * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32C; @@ -36,6 +42,8 @@ final class CompletedPart * calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha1; @@ -45,11 +53,15 @@ final class CompletedPart * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha256; /** * Part number that identifies the part. This is a positive integer between 1 and 10,000. + * + * @var int|null */ private $partNumber; diff --git a/src/Service/S3/src/ValueObject/CopyObjectResult.php b/src/Service/S3/src/ValueObject/CopyObjectResult.php index 1b174dccb..bcc6501f0 100644 --- a/src/Service/S3/src/ValueObject/CopyObjectResult.php +++ b/src/Service/S3/src/ValueObject/CopyObjectResult.php @@ -9,11 +9,15 @@ final class CopyObjectResult { /** * Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata. + * + * @var string|null */ private $etag; /** * Creation date of the object. + * + * @var \DateTimeImmutable|null */ private $lastModified; @@ -23,6 +27,8 @@ final class CopyObjectResult * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32; @@ -32,6 +38,8 @@ final class CopyObjectResult * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32C; @@ -41,6 +49,8 @@ final class CopyObjectResult * calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha1; @@ -50,6 +60,8 @@ final class CopyObjectResult * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha256; diff --git a/src/Service/S3/src/ValueObject/CreateBucketConfiguration.php b/src/Service/S3/src/ValueObject/CreateBucketConfiguration.php index 4d957612f..c87fc55a7 100644 --- a/src/Service/S3/src/ValueObject/CreateBucketConfiguration.php +++ b/src/Service/S3/src/ValueObject/CreateBucketConfiguration.php @@ -13,6 +13,8 @@ final class CreateBucketConfiguration /** * Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US * East (N. Virginia) Region (us-east-1). + * + * @var BucketLocationConstraint::*|null */ private $locationConstraint; diff --git a/src/Service/S3/src/ValueObject/Delete.php b/src/Service/S3/src/ValueObject/Delete.php index 9808c3555..461c4233d 100644 --- a/src/Service/S3/src/ValueObject/Delete.php +++ b/src/Service/S3/src/ValueObject/Delete.php @@ -11,11 +11,15 @@ final class Delete { /** * The object to delete. + * + * @var ObjectIdentifier[] */ private $objects; /** * Element to enable quiet mode for the request. When you add this element, you must set its value to true. + * + * @var bool|null */ private $quiet; diff --git a/src/Service/S3/src/ValueObject/DeletedObject.php b/src/Service/S3/src/ValueObject/DeletedObject.php index 699ed1cdd..63b892c73 100644 --- a/src/Service/S3/src/ValueObject/DeletedObject.php +++ b/src/Service/S3/src/ValueObject/DeletedObject.php @@ -9,23 +9,31 @@ final class DeletedObject { /** * The name of the deleted object. + * + * @var string|null */ private $key; /** * The version ID of the deleted object. + * + * @var string|null */ private $versionId; /** * Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In * a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created. + * + * @var bool|null */ private $deleteMarker; /** * The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object * version, the value returned by this header is the version ID of the object version deleted. + * + * @var string|null */ private $deleteMarkerVersionId; diff --git a/src/Service/S3/src/ValueObject/Error.php b/src/Service/S3/src/ValueObject/Error.php index a14fd2ef8..76757f941 100644 --- a/src/Service/S3/src/ValueObject/Error.php +++ b/src/Service/S3/src/ValueObject/Error.php @@ -11,11 +11,15 @@ final class Error { /** * The error key. + * + * @var string|null */ private $key; /** * The version ID of the error. + * + * @var string|null */ private $versionId; @@ -493,6 +497,8 @@ final class Error * [^3]: http://aws.amazon.com/s3 * [^4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html * [^5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html + * + * @var string|null */ private $code; @@ -501,6 +507,8 @@ final class Error * audience. Simple programs display the message directly to the end user if they encounter an error condition they * don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper * internationalization are more likely to ignore the error message. + * + * @var string|null */ private $message; diff --git a/src/Service/S3/src/ValueObject/FilterRule.php b/src/Service/S3/src/ValueObject/FilterRule.php index d93ec75fa..384862eb7 100644 --- a/src/Service/S3/src/ValueObject/FilterRule.php +++ b/src/Service/S3/src/ValueObject/FilterRule.php @@ -16,11 +16,15 @@ final class FilterRule * Configuring Event Notifications [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html + * + * @var FilterRuleName::*|null */ private $name; /** * The value that the filter searches for in object key names. + * + * @var string|null */ private $value; diff --git a/src/Service/S3/src/ValueObject/Grant.php b/src/Service/S3/src/ValueObject/Grant.php index 1ebc4bebc..7e2796aab 100644 --- a/src/Service/S3/src/ValueObject/Grant.php +++ b/src/Service/S3/src/ValueObject/Grant.php @@ -12,11 +12,15 @@ final class Grant { /** * The person being granted permissions. + * + * @var Grantee|null */ private $grantee; /** * Specifies the permission given to the grantee. + * + * @var Permission::*|null */ private $permission; diff --git a/src/Service/S3/src/ValueObject/Grantee.php b/src/Service/S3/src/ValueObject/Grantee.php index 7d8e269ac..02ec9e48c 100644 --- a/src/Service/S3/src/ValueObject/Grantee.php +++ b/src/Service/S3/src/ValueObject/Grantee.php @@ -12,6 +12,8 @@ final class Grantee { /** * Screen name of the grantee. + * + * @var string|null */ private $displayName; @@ -33,21 +35,29 @@ final class Grantee * > Services General Reference. * * [^1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region + * + * @var string|null */ private $emailAddress; /** * The canonical user ID of the grantee. + * + * @var string|null */ private $id; /** * Type of grantee. + * + * @var Type::* */ private $type; /** * URI of the grantee group. + * + * @var string|null */ private $uri; diff --git a/src/Service/S3/src/ValueObject/Initiator.php b/src/Service/S3/src/ValueObject/Initiator.php index 896c84794..92ac8cc85 100644 --- a/src/Service/S3/src/ValueObject/Initiator.php +++ b/src/Service/S3/src/ValueObject/Initiator.php @@ -10,11 +10,15 @@ final class Initiator /** * If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM * User, it provides a user ARN value. + * + * @var string|null */ private $id; /** * Name of the Principal. + * + * @var string|null */ private $displayName; diff --git a/src/Service/S3/src/ValueObject/LambdaFunctionConfiguration.php b/src/Service/S3/src/ValueObject/LambdaFunctionConfiguration.php index 9f7a44345..93560e896 100644 --- a/src/Service/S3/src/ValueObject/LambdaFunctionConfiguration.php +++ b/src/Service/S3/src/ValueObject/LambdaFunctionConfiguration.php @@ -10,10 +10,15 @@ */ final class LambdaFunctionConfiguration { + /** + * @var string|null + */ private $id; /** * The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the specified event type occurs. + * + * @var string */ private $lambdaFunctionArn; @@ -22,9 +27,14 @@ final class LambdaFunctionConfiguration * [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html + * + * @var list */ private $events; + /** + * @var NotificationConfigurationFilter|null + */ private $filter; /** diff --git a/src/Service/S3/src/ValueObject/MultipartUpload.php b/src/Service/S3/src/ValueObject/MultipartUpload.php index 8ff746f62..2123ffc64 100644 --- a/src/Service/S3/src/ValueObject/MultipartUpload.php +++ b/src/Service/S3/src/ValueObject/MultipartUpload.php @@ -12,36 +12,50 @@ final class MultipartUpload { /** * Upload ID that identifies the multipart upload. + * + * @var string|null */ private $uploadId; /** * Key of the object for which the multipart upload was initiated. + * + * @var string|null */ private $key; /** * Date and time at which the multipart upload was initiated. + * + * @var \DateTimeImmutable|null */ private $initiated; /** * The class of storage used to store the object. + * + * @var StorageClass::*|null */ private $storageClass; /** * Specifies the owner of the object that is part of the multipart upload. + * + * @var Owner|null */ private $owner; /** * Identifies who initiated the multipart upload. + * + * @var Initiator|null */ private $initiator; /** * The algorithm that was used to create a checksum of the object. + * + * @var ChecksumAlgorithm::*|null */ private $checksumAlgorithm; diff --git a/src/Service/S3/src/ValueObject/NotificationConfiguration.php b/src/Service/S3/src/ValueObject/NotificationConfiguration.php index b5bd41118..1ed51523e 100644 --- a/src/Service/S3/src/ValueObject/NotificationConfiguration.php +++ b/src/Service/S3/src/ValueObject/NotificationConfiguration.php @@ -10,21 +10,29 @@ final class NotificationConfiguration { /** * The topic to which notifications are sent and the events for which notifications are generated. + * + * @var TopicConfiguration[]|null */ private $topicConfigurations; /** * The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages. + * + * @var QueueConfiguration[]|null */ private $queueConfigurations; /** * Describes the Lambda functions to invoke and the events for which to invoke them. + * + * @var LambdaFunctionConfiguration[]|null */ private $lambdaFunctionConfigurations; /** * Enables delivery of events to Amazon EventBridge. + * + * @var EventBridgeConfiguration|null */ private $eventBridgeConfiguration; diff --git a/src/Service/S3/src/ValueObject/NotificationConfigurationFilter.php b/src/Service/S3/src/ValueObject/NotificationConfigurationFilter.php index 2707d244b..d50acbabe 100644 --- a/src/Service/S3/src/ValueObject/NotificationConfigurationFilter.php +++ b/src/Service/S3/src/ValueObject/NotificationConfigurationFilter.php @@ -10,6 +10,9 @@ */ final class NotificationConfigurationFilter { + /** + * @var S3KeyFilter|null + */ private $key; /** diff --git a/src/Service/S3/src/ValueObject/ObjectIdentifier.php b/src/Service/S3/src/ValueObject/ObjectIdentifier.php index 4b7a150f1..24c7ede8d 100644 --- a/src/Service/S3/src/ValueObject/ObjectIdentifier.php +++ b/src/Service/S3/src/ValueObject/ObjectIdentifier.php @@ -16,11 +16,15 @@ final class ObjectIdentifier * ! requests. For more information, see XML related object key constraints [^1]. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints + * + * @var string */ private $key; /** * VersionId for the specific version of the object to delete. + * + * @var string|null */ private $versionId; diff --git a/src/Service/S3/src/ValueObject/Owner.php b/src/Service/S3/src/ValueObject/Owner.php index 2ff5885e0..43f1910a0 100644 --- a/src/Service/S3/src/ValueObject/Owner.php +++ b/src/Service/S3/src/ValueObject/Owner.php @@ -19,11 +19,15 @@ final class Owner * - Asia Pacific (Tokyo) * - Europe (Ireland) * - South America (São Paulo) + * + * @var string|null */ private $displayName; /** * Container for the ID of the owner. + * + * @var string|null */ private $id; diff --git a/src/Service/S3/src/ValueObject/Part.php b/src/Service/S3/src/ValueObject/Part.php index f278467a7..90fbbc902 100644 --- a/src/Service/S3/src/ValueObject/Part.php +++ b/src/Service/S3/src/ValueObject/Part.php @@ -9,21 +9,29 @@ final class Part { /** * Part number identifying the part. This is a positive integer between 1 and 10,000. + * + * @var int|null */ private $partNumber; /** * Date and time at which the part was uploaded. + * + * @var \DateTimeImmutable|null */ private $lastModified; /** * Entity tag returned when the part was uploaded. + * + * @var string|null */ private $etag; /** * Size in bytes of the uploaded part data. + * + * @var int|null */ private $size; @@ -33,6 +41,8 @@ final class Part * see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html + * + * @var string|null */ private $checksumCrc32; @@ -42,6 +52,8 @@ final class Part * checksums are calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumCrc32C; @@ -51,6 +63,8 @@ final class Part * calculated with multipart uploads, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums + * + * @var string|null */ private $checksumSha1; @@ -60,6 +74,8 @@ final class Part * information, see Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html + * + * @var string|null */ private $checksumSha256; diff --git a/src/Service/S3/src/ValueObject/QueueConfiguration.php b/src/Service/S3/src/ValueObject/QueueConfiguration.php index 3dc5694bb..29a6c78d1 100644 --- a/src/Service/S3/src/ValueObject/QueueConfiguration.php +++ b/src/Service/S3/src/ValueObject/QueueConfiguration.php @@ -11,19 +11,29 @@ */ final class QueueConfiguration { + /** + * @var string|null + */ private $id; /** * The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events * of the specified type. + * + * @var string */ private $queueArn; /** * A collection of bucket events for which to send notifications. + * + * @var list */ private $events; + /** + * @var NotificationConfigurationFilter|null + */ private $filter; /** diff --git a/src/Service/S3/src/ValueObject/S3KeyFilter.php b/src/Service/S3/src/ValueObject/S3KeyFilter.php index 4886c3c73..4cd6925ed 100644 --- a/src/Service/S3/src/ValueObject/S3KeyFilter.php +++ b/src/Service/S3/src/ValueObject/S3KeyFilter.php @@ -7,6 +7,9 @@ */ final class S3KeyFilter { + /** + * @var FilterRule[]|null + */ private $filterRules; /** diff --git a/src/Service/S3/src/ValueObject/ServerSideEncryptionByDefault.php b/src/Service/S3/src/ValueObject/ServerSideEncryptionByDefault.php index 186fd138f..36f4a6384 100644 --- a/src/Service/S3/src/ValueObject/ServerSideEncryptionByDefault.php +++ b/src/Service/S3/src/ValueObject/ServerSideEncryptionByDefault.php @@ -18,6 +18,8 @@ final class ServerSideEncryptionByDefault { /** * Server-side encryption algorithm to use for the default encryption. + * + * @var ServerSideEncryption::* */ private $sseAlgorithm; @@ -39,6 +41,8 @@ final class ServerSideEncryptionByDefault * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy * [^2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html + * + * @var string|null */ private $kmsMasterKeyId; diff --git a/src/Service/S3/src/ValueObject/ServerSideEncryptionConfiguration.php b/src/Service/S3/src/ValueObject/ServerSideEncryptionConfiguration.php index f5035ea73..5b598b2b6 100644 --- a/src/Service/S3/src/ValueObject/ServerSideEncryptionConfiguration.php +++ b/src/Service/S3/src/ValueObject/ServerSideEncryptionConfiguration.php @@ -11,6 +11,8 @@ final class ServerSideEncryptionConfiguration { /** * Container for information about a particular server-side encryption configuration rule. + * + * @var ServerSideEncryptionRule[] */ private $rules; diff --git a/src/Service/S3/src/ValueObject/ServerSideEncryptionRule.php b/src/Service/S3/src/ValueObject/ServerSideEncryptionRule.php index 2c76d8fb3..ded004a3f 100644 --- a/src/Service/S3/src/ValueObject/ServerSideEncryptionRule.php +++ b/src/Service/S3/src/ValueObject/ServerSideEncryptionRule.php @@ -10,6 +10,8 @@ final class ServerSideEncryptionRule /** * Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't * specify any server-side encryption, this default encryption will be applied. + * + * @var ServerSideEncryptionByDefault|null */ private $applyServerSideEncryptionByDefault; @@ -21,6 +23,8 @@ final class ServerSideEncryptionRule * For more information, see Amazon S3 Bucket Keys [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html + * + * @var bool|null */ private $bucketKeyEnabled; diff --git a/src/Service/S3/src/ValueObject/Tag.php b/src/Service/S3/src/ValueObject/Tag.php index 3cc4c19eb..13affe7d1 100644 --- a/src/Service/S3/src/ValueObject/Tag.php +++ b/src/Service/S3/src/ValueObject/Tag.php @@ -11,11 +11,15 @@ final class Tag { /** * Name of the object key. + * + * @var string */ private $key; /** * Value of the tag. + * + * @var string */ private $value; diff --git a/src/Service/S3/src/ValueObject/Tagging.php b/src/Service/S3/src/ValueObject/Tagging.php index 25fdddf4c..fb586ddfd 100644 --- a/src/Service/S3/src/ValueObject/Tagging.php +++ b/src/Service/S3/src/ValueObject/Tagging.php @@ -11,6 +11,8 @@ final class Tagging { /** * A collection for a set of tags. + * + * @var Tag[] */ private $tagSet; diff --git a/src/Service/S3/src/ValueObject/TopicConfiguration.php b/src/Service/S3/src/ValueObject/TopicConfiguration.php index ae4f4ef31..6f1eb0050 100644 --- a/src/Service/S3/src/ValueObject/TopicConfiguration.php +++ b/src/Service/S3/src/ValueObject/TopicConfiguration.php @@ -11,11 +11,16 @@ */ final class TopicConfiguration { + /** + * @var string|null + */ private $id; /** * The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events * of the specified type. + * + * @var string */ private $topicArn; @@ -24,9 +29,14 @@ final class TopicConfiguration * the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html + * + * @var list */ private $events; + /** + * @var NotificationConfigurationFilter|null + */ private $filter; /** diff --git a/src/Service/Scheduler/src/Result/CreateScheduleGroupOutput.php b/src/Service/Scheduler/src/Result/CreateScheduleGroupOutput.php index bf68e41d4..be1bd0436 100644 --- a/src/Service/Scheduler/src/Result/CreateScheduleGroupOutput.php +++ b/src/Service/Scheduler/src/Result/CreateScheduleGroupOutput.php @@ -9,6 +9,8 @@ class CreateScheduleGroupOutput extends Result { /** * The Amazon Resource Name (ARN) of the schedule group. + * + * @var string */ private $scheduleGroupArn; diff --git a/src/Service/Scheduler/src/Result/CreateScheduleOutput.php b/src/Service/Scheduler/src/Result/CreateScheduleOutput.php index 4e157ff5a..18a8c361c 100644 --- a/src/Service/Scheduler/src/Result/CreateScheduleOutput.php +++ b/src/Service/Scheduler/src/Result/CreateScheduleOutput.php @@ -9,6 +9,8 @@ class CreateScheduleOutput extends Result { /** * The Amazon Resource Name (ARN) of the schedule. + * + * @var string */ private $scheduleArn; diff --git a/src/Service/Scheduler/src/Result/GetScheduleGroupOutput.php b/src/Service/Scheduler/src/Result/GetScheduleGroupOutput.php index 4f8391f97..6e3e6c8bb 100644 --- a/src/Service/Scheduler/src/Result/GetScheduleGroupOutput.php +++ b/src/Service/Scheduler/src/Result/GetScheduleGroupOutput.php @@ -10,26 +10,36 @@ class GetScheduleGroupOutput extends Result { /** * The Amazon Resource Name (ARN) of the schedule group. + * + * @var string|null */ private $arn; /** * The time at which the schedule group was created. + * + * @var \DateTimeImmutable|null */ private $creationDate; /** * The time at which the schedule group was last modified. + * + * @var \DateTimeImmutable|null */ private $lastModificationDate; /** * The name of the schedule group. + * + * @var string|null */ private $name; /** * Specifies the state of the schedule group. + * + * @var ScheduleGroupState::*|null */ private $state; diff --git a/src/Service/Scheduler/src/Result/GetScheduleOutput.php b/src/Service/Scheduler/src/Result/GetScheduleOutput.php index b48ad913b..33f85cf02 100644 --- a/src/Service/Scheduler/src/Result/GetScheduleOutput.php +++ b/src/Service/Scheduler/src/Result/GetScheduleOutput.php @@ -25,16 +25,22 @@ class GetScheduleOutput extends Result { /** * The Amazon Resource Name (ARN) of the schedule. + * + * @var string|null */ private $arn; /** * The time at which the schedule was created. + * + * @var \DateTimeImmutable|null */ private $creationDate; /** * The description of the schedule. + * + * @var string|null */ private $description; @@ -42,31 +48,43 @@ class GetScheduleOutput extends Result * The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, * invocations might stop on, or before, the `EndDate` you specify. EventBridge Scheduler ignores `EndDate` for one-time * schedules. + * + * @var \DateTimeImmutable|null */ private $endDate; /** * Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. + * + * @var FlexibleTimeWindow|null */ private $flexibleTimeWindow; /** * The name of the schedule group associated with this schedule. + * + * @var string|null */ private $groupName; /** * The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data. + * + * @var string|null */ private $kmsKeyArn; /** * The time at which the schedule was last modified. + * + * @var \DateTimeImmutable|null */ private $lastModificationDate; /** * The name of the schedule. + * + * @var string|null */ private $name; @@ -93,11 +111,15 @@ class GetScheduleOutput extends Result * User Guide*. * * [^1]: https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html + * + * @var string|null */ private $scheduleExpression; /** * The timezone in which the scheduling expression is evaluated. + * + * @var string|null */ private $scheduleExpressionTimezone; @@ -105,16 +127,22 @@ class GetScheduleOutput extends Result * The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence * expression, invocations might occur on, or after, the `StartDate` you specify. EventBridge Scheduler ignores * `StartDate` for one-time schedules. + * + * @var \DateTimeImmutable|null */ private $startDate; /** * Specifies whether the schedule is enabled or disabled. + * + * @var ScheduleState::*|null */ private $state; /** * The schedule target. + * + * @var Target|null */ private $target; diff --git a/src/Service/Scheduler/src/Result/ListScheduleGroupsOutput.php b/src/Service/Scheduler/src/Result/ListScheduleGroupsOutput.php index 4531464d0..8c56de671 100644 --- a/src/Service/Scheduler/src/Result/ListScheduleGroupsOutput.php +++ b/src/Service/Scheduler/src/Result/ListScheduleGroupsOutput.php @@ -16,11 +16,15 @@ class ListScheduleGroupsOutput extends Result implements \IteratorAggregate { /** * Indicates whether there are additional results to retrieve. If the value is null, there are no more results. + * + * @var string|null */ private $nextToken; /** * The schedule groups that match the specified criteria. + * + * @var ScheduleGroupSummary[] */ private $scheduleGroups; diff --git a/src/Service/Scheduler/src/Result/ListSchedulesOutput.php b/src/Service/Scheduler/src/Result/ListSchedulesOutput.php index a41b4b641..66f0c0ad9 100644 --- a/src/Service/Scheduler/src/Result/ListSchedulesOutput.php +++ b/src/Service/Scheduler/src/Result/ListSchedulesOutput.php @@ -17,11 +17,15 @@ class ListSchedulesOutput extends Result implements \IteratorAggregate { /** * Indicates whether there are additional results to retrieve. If the value is null, there are no more results. + * + * @var string|null */ private $nextToken; /** * The schedules that match the specified criteria. + * + * @var ScheduleSummary[] */ private $schedules; diff --git a/src/Service/Scheduler/src/Result/UpdateScheduleOutput.php b/src/Service/Scheduler/src/Result/UpdateScheduleOutput.php index fce9c01dd..8a2f7e754 100644 --- a/src/Service/Scheduler/src/Result/UpdateScheduleOutput.php +++ b/src/Service/Scheduler/src/Result/UpdateScheduleOutput.php @@ -9,6 +9,8 @@ class UpdateScheduleOutput extends Result { /** * The Amazon Resource Name (ARN) of the schedule that you updated. + * + * @var string */ private $scheduleArn; diff --git a/src/Service/Scheduler/src/ValueObject/AwsVpcConfiguration.php b/src/Service/Scheduler/src/ValueObject/AwsVpcConfiguration.php index 24cccfdb6..e353b6aa9 100644 --- a/src/Service/Scheduler/src/ValueObject/AwsVpcConfiguration.php +++ b/src/Service/Scheduler/src/ValueObject/AwsVpcConfiguration.php @@ -14,6 +14,8 @@ final class AwsVpcConfiguration /** * Specifies whether the task's elastic network interface receives a public IP address. You can specify `ENABLED` only * when `LaunchType` in `EcsParameters` is set to `FARGATE`. + * + * @var AssignPublicIp::*|null */ private $assignPublicIp; @@ -21,12 +23,16 @@ final class AwsVpcConfiguration * Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can * specify as many as five security groups. If you do not specify a security group, the default security group for the * VPC is used. + * + * @var string[]|null */ private $securityGroups; /** * Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as * 16 subnets. + * + * @var string[] */ private $subnets; diff --git a/src/Service/Scheduler/src/ValueObject/CapacityProviderStrategyItem.php b/src/Service/Scheduler/src/ValueObject/CapacityProviderStrategyItem.php index a705d8a29..8029b5a81 100644 --- a/src/Service/Scheduler/src/ValueObject/CapacityProviderStrategyItem.php +++ b/src/Service/Scheduler/src/ValueObject/CapacityProviderStrategyItem.php @@ -13,11 +13,15 @@ final class CapacityProviderStrategyItem * The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity * provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of `0` * is used. + * + * @var int|null */ private $base; /** * The short name of the capacity provider. + * + * @var string */ private $capacityProvider; @@ -25,6 +29,8 @@ final class CapacityProviderStrategyItem * The weight value designates the relative percentage of the total number of tasks launched that should use the * specified capacity provider. The weight value is taken into consideration after the base value, if defined, is * satisfied. + * + * @var int|null */ private $weight; diff --git a/src/Service/Scheduler/src/ValueObject/DeadLetterConfig.php b/src/Service/Scheduler/src/ValueObject/DeadLetterConfig.php index 7d4fde28c..60020697d 100644 --- a/src/Service/Scheduler/src/ValueObject/DeadLetterConfig.php +++ b/src/Service/Scheduler/src/ValueObject/DeadLetterConfig.php @@ -11,6 +11,8 @@ final class DeadLetterConfig { /** * The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue. + * + * @var string|null */ private $arn; diff --git a/src/Service/Scheduler/src/ValueObject/EcsParameters.php b/src/Service/Scheduler/src/ValueObject/EcsParameters.php index ad7654257..bbeec3548 100644 --- a/src/Service/Scheduler/src/ValueObject/EcsParameters.php +++ b/src/Service/Scheduler/src/ValueObject/EcsParameters.php @@ -15,6 +15,8 @@ final class EcsParameters { /** * The capacity provider strategy to use for the task. + * + * @var CapacityProviderStrategyItem[]|null */ private $capacityProviderStrategy; @@ -23,17 +25,23 @@ final class EcsParameters * Resources [^1] in the *Amazon ECS Developer Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html + * + * @var bool|null */ private $enableEcsManagedTags; /** * Whether or not to enable the execute command functionality for the containers in this task. If true, this enables * execute command functionality on all containers in the task. + * + * @var bool|null */ private $enableExecuteCommand; /** * Specifies an ECS task group for the task. The maximum length is 255 characters. + * + * @var string|null */ private $group; @@ -44,28 +52,38 @@ final class EcsParameters * Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html + * + * @var LaunchType::*|null */ private $launchType; /** * This structure specifies the network configuration for an ECS task. + * + * @var NetworkConfiguration|null */ private $networkConfiguration; /** * An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task * (including constraints in the task definition and those specified at runtime). + * + * @var PlacementConstraint[]|null */ private $placementConstraints; /** * The task placement strategy for a task or service. + * + * @var PlacementStrategy[]|null */ private $placementStrategy; /** * Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as * `1.1.0`. + * + * @var string|null */ private $platformVersion; @@ -75,11 +93,15 @@ final class EcsParameters * creation, use Amazon ECS's `TagResource` [^1] API action. * * [^1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html + * + * @var PropagateTags::*|null */ private $propagateTags; /** * The reference ID to use for the task. + * + * @var string|null */ private $referenceId; @@ -88,16 +110,22 @@ final class EcsParameters * optional value, both of which you define. For more information, see `RunTask` [^1] in the *Amazon ECS API Reference*. * * [^1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html + * + * @var array[]|null */ private $tags; /** * The number of tasks to create based on `TaskDefinition`. The default is `1`. + * + * @var int|null */ private $taskCount; /** * The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task. + * + * @var string */ private $taskDefinitionArn; diff --git a/src/Service/Scheduler/src/ValueObject/EventBridgeParameters.php b/src/Service/Scheduler/src/ValueObject/EventBridgeParameters.php index 592af3612..bf2aef4c6 100644 --- a/src/Service/Scheduler/src/ValueObject/EventBridgeParameters.php +++ b/src/Service/Scheduler/src/ValueObject/EventBridgeParameters.php @@ -13,11 +13,15 @@ final class EventBridgeParameters { /** * A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. + * + * @var string */ private $detailType; /** * The source of the event. + * + * @var string */ private $source; diff --git a/src/Service/Scheduler/src/ValueObject/FlexibleTimeWindow.php b/src/Service/Scheduler/src/ValueObject/FlexibleTimeWindow.php index c0f4e0951..736c8b7e7 100644 --- a/src/Service/Scheduler/src/ValueObject/FlexibleTimeWindow.php +++ b/src/Service/Scheduler/src/ValueObject/FlexibleTimeWindow.php @@ -12,11 +12,15 @@ final class FlexibleTimeWindow { /** * The maximum time window during which a schedule can be invoked. + * + * @var int|null */ private $maximumWindowInMinutes; /** * Determines whether the schedule is invoked within a flexible time window. + * + * @var FlexibleTimeWindowMode::* */ private $mode; diff --git a/src/Service/Scheduler/src/ValueObject/KinesisParameters.php b/src/Service/Scheduler/src/ValueObject/KinesisParameters.php index 6f1877b3f..ffb89efa8 100644 --- a/src/Service/Scheduler/src/ValueObject/KinesisParameters.php +++ b/src/Service/Scheduler/src/ValueObject/KinesisParameters.php @@ -16,6 +16,8 @@ final class KinesisParameters * Streams terminology and concepts [^1] in the *Amazon Kinesis Streams Developer Guide*. * * [^1]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html + * + * @var string */ private $partitionKey; diff --git a/src/Service/Scheduler/src/ValueObject/NetworkConfiguration.php b/src/Service/Scheduler/src/ValueObject/NetworkConfiguration.php index b76b05550..37f5a55e4 100644 --- a/src/Service/Scheduler/src/ValueObject/NetworkConfiguration.php +++ b/src/Service/Scheduler/src/ValueObject/NetworkConfiguration.php @@ -10,6 +10,8 @@ final class NetworkConfiguration /** * Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. * This structure is relevant only for ECS tasks that use the awsvpc network mode. + * + * @var AwsVpcConfiguration|null */ private $awsvpcConfiguration; diff --git a/src/Service/Scheduler/src/ValueObject/PlacementConstraint.php b/src/Service/Scheduler/src/ValueObject/PlacementConstraint.php index dfb9163a7..ddaf61b1d 100644 --- a/src/Service/Scheduler/src/ValueObject/PlacementConstraint.php +++ b/src/Service/Scheduler/src/ValueObject/PlacementConstraint.php @@ -16,12 +16,16 @@ final class PlacementConstraint * Guide*. * * [^1]: https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html + * + * @var string|null */ private $expression; /** * The type of constraint. Use `distinctInstance` to ensure that each task in a particular group is running on a * different container instance. Use `memberOf` to restrict the selection to a group of valid candidates. + * + * @var PlacementConstraintType::*|null */ private $type; diff --git a/src/Service/Scheduler/src/ValueObject/PlacementStrategy.php b/src/Service/Scheduler/src/ValueObject/PlacementStrategy.php index 1e0e0657c..8589f93cb 100644 --- a/src/Service/Scheduler/src/ValueObject/PlacementStrategy.php +++ b/src/Service/Scheduler/src/ValueObject/PlacementStrategy.php @@ -15,6 +15,8 @@ final class PlacementStrategy * (or `instanceId`, which has the same effect), or any platform or custom attribute that is applied to a container * instance, such as `attribute:ecs.availability-zone`. For the binpack placement strategy, valid values are `cpu` and * `memory`. For the random placement strategy, this field is not used. + * + * @var string|null */ private $field; @@ -24,6 +26,8 @@ final class PlacementStrategy * binpack strategy places tasks on available candidates that have the least available amount of the resource that is * specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the * least amount of remaining memory (but still enough to run the task). + * + * @var PlacementStrategyType::*|null */ private $type; diff --git a/src/Service/Scheduler/src/ValueObject/RetryPolicy.php b/src/Service/Scheduler/src/ValueObject/RetryPolicy.php index d07915644..cffcd912c 100644 --- a/src/Service/Scheduler/src/ValueObject/RetryPolicy.php +++ b/src/Service/Scheduler/src/ValueObject/RetryPolicy.php @@ -10,6 +10,8 @@ final class RetryPolicy { /** * The maximum amount of time, in seconds, to continue to make retry attempts. + * + * @var int|null */ private $maximumEventAgeInSeconds; @@ -17,6 +19,8 @@ final class RetryPolicy * The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff * continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` * is reached. + * + * @var int|null */ private $maximumRetryAttempts; diff --git a/src/Service/Scheduler/src/ValueObject/SageMakerPipelineParameter.php b/src/Service/Scheduler/src/ValueObject/SageMakerPipelineParameter.php index 6bdf510ac..3b04478c8 100644 --- a/src/Service/Scheduler/src/ValueObject/SageMakerPipelineParameter.php +++ b/src/Service/Scheduler/src/ValueObject/SageMakerPipelineParameter.php @@ -11,11 +11,15 @@ final class SageMakerPipelineParameter { /** * Name of parameter to start execution of a SageMaker Model Building Pipeline. + * + * @var string */ private $name; /** * Value of parameter to start execution of a SageMaker Model Building Pipeline. + * + * @var string */ private $value; diff --git a/src/Service/Scheduler/src/ValueObject/SageMakerPipelineParameters.php b/src/Service/Scheduler/src/ValueObject/SageMakerPipelineParameters.php index de5d181e9..136a180df 100644 --- a/src/Service/Scheduler/src/ValueObject/SageMakerPipelineParameters.php +++ b/src/Service/Scheduler/src/ValueObject/SageMakerPipelineParameters.php @@ -11,6 +11,8 @@ final class SageMakerPipelineParameters { /** * List of parameter names and values to use when executing the SageMaker Model Building Pipeline. + * + * @var SageMakerPipelineParameter[]|null */ private $pipelineParameterList; diff --git a/src/Service/Scheduler/src/ValueObject/ScheduleGroupSummary.php b/src/Service/Scheduler/src/ValueObject/ScheduleGroupSummary.php index f441e038c..b27c96e10 100644 --- a/src/Service/Scheduler/src/ValueObject/ScheduleGroupSummary.php +++ b/src/Service/Scheduler/src/ValueObject/ScheduleGroupSummary.php @@ -11,26 +11,36 @@ final class ScheduleGroupSummary { /** * The Amazon Resource Name (ARN) of the schedule group. + * + * @var string|null */ private $arn; /** * The time at which the schedule group was created. + * + * @var \DateTimeImmutable|null */ private $creationDate; /** * The time at which the schedule group was last modified. + * + * @var \DateTimeImmutable|null */ private $lastModificationDate; /** * The name of the schedule group. + * + * @var string|null */ private $name; /** * Specifies the state of the schedule group. + * + * @var ScheduleGroupState::*|null */ private $state; diff --git a/src/Service/Scheduler/src/ValueObject/ScheduleSummary.php b/src/Service/Scheduler/src/ValueObject/ScheduleSummary.php index 6b88cc274..d575162cf 100644 --- a/src/Service/Scheduler/src/ValueObject/ScheduleSummary.php +++ b/src/Service/Scheduler/src/ValueObject/ScheduleSummary.php @@ -11,36 +11,50 @@ final class ScheduleSummary { /** * The Amazon Resource Name (ARN) of the schedule. + * + * @var string|null */ private $arn; /** * The time at which the schedule was created. + * + * @var \DateTimeImmutable|null */ private $creationDate; /** * The name of the schedule group associated with this schedule. + * + * @var string|null */ private $groupName; /** * The time at which the schedule was last modified. + * + * @var \DateTimeImmutable|null */ private $lastModificationDate; /** * The name of the schedule. + * + * @var string|null */ private $name; /** * Specifies whether the schedule is enabled or disabled. + * + * @var ScheduleState::*|null */ private $state; /** * The schedule's target details. + * + * @var TargetSummary|null */ private $target; diff --git a/src/Service/Scheduler/src/ValueObject/SqsParameters.php b/src/Service/Scheduler/src/ValueObject/SqsParameters.php index 87cbef630..11ae1b6ff 100644 --- a/src/Service/Scheduler/src/ValueObject/SqsParameters.php +++ b/src/Service/Scheduler/src/ValueObject/SqsParameters.php @@ -15,6 +15,8 @@ final class SqsParameters { /** * The FIFO message group ID to use as the target. + * + * @var string|null */ private $messageGroupId; diff --git a/src/Service/Scheduler/src/ValueObject/Tag.php b/src/Service/Scheduler/src/ValueObject/Tag.php index dba0a1c1c..0fe296237 100644 --- a/src/Service/Scheduler/src/ValueObject/Tag.php +++ b/src/Service/Scheduler/src/ValueObject/Tag.php @@ -11,11 +11,15 @@ final class Tag { /** * The key for the tag. + * + * @var string */ private $key; /** * The value for the tag. + * + * @var string */ private $value; diff --git a/src/Service/Scheduler/src/ValueObject/Target.php b/src/Service/Scheduler/src/ValueObject/Target.php index c30b92a9f..e0fad1536 100644 --- a/src/Service/Scheduler/src/ValueObject/Target.php +++ b/src/Service/Scheduler/src/ValueObject/Target.php @@ -13,6 +13,8 @@ final class Target { /** * The Amazon Resource Name (ARN) of the target. + * + * @var string */ private $arn; @@ -20,6 +22,8 @@ final class Target * An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue * for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully * delivered to a target to the queue. + * + * @var DeadLetterConfig|null */ private $deadLetterConfig; @@ -27,6 +31,8 @@ final class Target * The templated target type for the Amazon ECS `RunTask` [^1] API operation. * * [^1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html + * + * @var EcsParameters|null */ private $ecsParameters; @@ -34,6 +40,8 @@ final class Target * The templated target type for the EventBridge `PutEvents` [^1] API operation. * * [^1]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html + * + * @var EventBridgeParameters|null */ private $eventBridgeParameters; @@ -42,6 +50,8 @@ final class Target * or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not * required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the * target. + * + * @var string|null */ private $input; @@ -49,18 +59,24 @@ final class Target * The templated target type for the Amazon Kinesis `PutRecord` [^1] API operation. * * [^1]: kinesis/latest/APIReference/API_PutRecord.html + * + * @var KinesisParameters|null */ private $kinesisParameters; /** * A `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an * event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target. + * + * @var RetryPolicy|null */ private $retryPolicy; /** * The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule * is invoked. + * + * @var string */ private $roleArn; @@ -68,6 +84,8 @@ final class Target * The templated target type for the Amazon SageMaker `StartPipelineExecution` [^1] API operation. * * [^1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html + * + * @var SageMakerPipelineParameters|null */ private $sageMakerPipelineParameters; @@ -79,6 +97,8 @@ final class Target * * [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html * [^2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html + * + * @var SqsParameters|null */ private $sqsParameters; diff --git a/src/Service/Scheduler/src/ValueObject/TargetSummary.php b/src/Service/Scheduler/src/ValueObject/TargetSummary.php index 6a0365241..bf8b28579 100644 --- a/src/Service/Scheduler/src/ValueObject/TargetSummary.php +++ b/src/Service/Scheduler/src/ValueObject/TargetSummary.php @@ -11,6 +11,8 @@ final class TargetSummary { /** * The Amazon Resource Name (ARN) of the target. + * + * @var string */ private $arn; diff --git a/src/Service/SecretsManager/src/Result/CreateSecretResponse.php b/src/Service/SecretsManager/src/Result/CreateSecretResponse.php index 70de9d068..799516a2b 100644 --- a/src/Service/SecretsManager/src/Result/CreateSecretResponse.php +++ b/src/Service/SecretsManager/src/Result/CreateSecretResponse.php @@ -12,16 +12,22 @@ class CreateSecretResponse extends Result * The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures * that if you create a new secret with the same name as a deleted secret, then users with access to the old secret * don't get access to the new secret because the ARNs are different. + * + * @var string|null */ private $arn; /** * The name of the new secret. + * + * @var string|null */ private $name; /** * The unique identifier associated with the version of the new secret. + * + * @var string|null */ private $versionId; @@ -31,6 +37,8 @@ class CreateSecretResponse extends Result * - `Failed`, which indicates that the replica was not created. * - `InProgress`, which indicates that Secrets Manager is in the process of creating the replica. * - `InSync`, which indicates that the replica was created. + * + * @var ReplicationStatusType[] */ private $replicationStatus; diff --git a/src/Service/SecretsManager/src/Result/DeleteSecretResponse.php b/src/Service/SecretsManager/src/Result/DeleteSecretResponse.php index 4fd7eac64..9fce19fed 100644 --- a/src/Service/SecretsManager/src/Result/DeleteSecretResponse.php +++ b/src/Service/SecretsManager/src/Result/DeleteSecretResponse.php @@ -9,17 +9,23 @@ class DeleteSecretResponse extends Result { /** * The ARN of the secret. + * + * @var string|null */ private $arn; /** * The name of the secret. + * + * @var string|null */ private $name; /** * The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be * restored. This value is the date and time of the delete request plus the number of days in `RecoveryWindowInDays`. + * + * @var \DateTimeImmutable|null */ private $deletionDate; diff --git a/src/Service/SecretsManager/src/Result/GetSecretValueResponse.php b/src/Service/SecretsManager/src/Result/GetSecretValueResponse.php index e7da133f7..9862e575f 100644 --- a/src/Service/SecretsManager/src/Result/GetSecretValueResponse.php +++ b/src/Service/SecretsManager/src/Result/GetSecretValueResponse.php @@ -9,16 +9,22 @@ class GetSecretValueResponse extends Result { /** * The ARN of the secret. + * + * @var string|null */ private $arn; /** * The friendly name of the secret. + * + * @var string|null */ private $name; /** * The unique identifier of this version of the secret. + * + * @var string|null */ private $versionId; @@ -30,6 +36,8 @@ class GetSecretValueResponse extends Result * string, then this field is omitted. The secret value appears in `SecretString` instead. * * [^1]: https://tools.ietf.org/html/rfc4648#section-4 + * + * @var string|null */ private $secretBinary; @@ -39,17 +47,23 @@ class GetSecretValueResponse extends Result * * If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of * key/value pairs. + * + * @var string|null */ private $secretString; /** * A list of all of the staging labels currently attached to this version of the secret. + * + * @var string[] */ private $versionStages; /** * The date and time that this version of the secret was created. If you don't specify which version in `VersionId` or * `VersionStage`, then Secrets Manager uses the `AWSCURRENT` version. + * + * @var \DateTimeImmutable|null */ private $createdDate; diff --git a/src/Service/SecretsManager/src/Result/ListSecretsResponse.php b/src/Service/SecretsManager/src/Result/ListSecretsResponse.php index 8db1cf268..0ddfa3748 100644 --- a/src/Service/SecretsManager/src/Result/ListSecretsResponse.php +++ b/src/Service/SecretsManager/src/Result/ListSecretsResponse.php @@ -18,6 +18,8 @@ class ListSecretsResponse extends Result implements \IteratorAggregate { /** * A list of the secrets in the account. + * + * @var SecretListEntry[] */ private $secretList; @@ -25,6 +27,8 @@ class ListSecretsResponse extends Result implements \IteratorAggregate * Secrets Manager includes this value if there's more output available than what is included in the current response. * This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long * list. To get the next results, call `ListSecrets` again with this value. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/SecretsManager/src/Result/PutSecretValueResponse.php b/src/Service/SecretsManager/src/Result/PutSecretValueResponse.php index 4e75bb5ac..f272c1fc0 100644 --- a/src/Service/SecretsManager/src/Result/PutSecretValueResponse.php +++ b/src/Service/SecretsManager/src/Result/PutSecretValueResponse.php @@ -9,22 +9,30 @@ class PutSecretValueResponse extends Result { /** * The ARN of the secret. + * + * @var string|null */ private $arn; /** * The name of the secret. + * + * @var string|null */ private $name; /** * The unique identifier of the version of the secret. + * + * @var string|null */ private $versionId; /** * The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging * labels to track a version as it progresses through the secret rotation process. + * + * @var string[] */ private $versionStages; diff --git a/src/Service/SecretsManager/src/Result/UpdateSecretResponse.php b/src/Service/SecretsManager/src/Result/UpdateSecretResponse.php index 8df5267d3..e275db4f4 100644 --- a/src/Service/SecretsManager/src/Result/UpdateSecretResponse.php +++ b/src/Service/SecretsManager/src/Result/UpdateSecretResponse.php @@ -9,17 +9,23 @@ class UpdateSecretResponse extends Result { /** * The ARN of the secret that was updated. + * + * @var string|null */ private $arn; /** * The name of the secret that was updated. + * + * @var string|null */ private $name; /** * If Secrets Manager created a new version of the secret during this operation, then `VersionId` contains the unique * identifier of the new version. + * + * @var string|null */ private $versionId; diff --git a/src/Service/SecretsManager/src/ValueObject/Filter.php b/src/Service/SecretsManager/src/ValueObject/Filter.php index 844bd2400..63b435d33 100644 --- a/src/Service/SecretsManager/src/ValueObject/Filter.php +++ b/src/Service/SecretsManager/src/ValueObject/Filter.php @@ -24,6 +24,8 @@ final class Filter * - **owning-service**: Prefix match, case-sensitive. * - **all**: Breaks the filter value string into words and then searches all attributes for matches. Not * case-sensitive. + * + * @var FilterNameStringType::*|null */ private $key; @@ -31,6 +33,8 @@ final class Filter * The keyword to filter for. * * You can prefix your search value with an exclamation mark (`!`) in order to perform negation filters. + * + * @var string[]|null */ private $values; diff --git a/src/Service/SecretsManager/src/ValueObject/ReplicaRegionType.php b/src/Service/SecretsManager/src/ValueObject/ReplicaRegionType.php index 96d043a9b..d8b4aef04 100644 --- a/src/Service/SecretsManager/src/ValueObject/ReplicaRegionType.php +++ b/src/Service/SecretsManager/src/ValueObject/ReplicaRegionType.php @@ -11,12 +11,16 @@ final class ReplicaRegionType * A Region code. For a list of Region codes, see Name and code of Regions [^1]. * * [^1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints + * + * @var string|null */ private $region; /** * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses * `aws/secretsmanager`. + * + * @var string|null */ private $kmsKeyId; diff --git a/src/Service/SecretsManager/src/ValueObject/ReplicationStatusType.php b/src/Service/SecretsManager/src/ValueObject/ReplicationStatusType.php index abf4a8c80..7b4618334 100644 --- a/src/Service/SecretsManager/src/ValueObject/ReplicationStatusType.php +++ b/src/Service/SecretsManager/src/ValueObject/ReplicationStatusType.php @@ -12,27 +12,37 @@ final class ReplicationStatusType { /** * The Region where replication occurs. + * + * @var string|null */ private $region; /** * Can be an `ARN`, `Key ID`, or `Alias`. + * + * @var string|null */ private $kmsKeyId; /** * The status can be `InProgress`, `Failed`, or `InSync`. + * + * @var StatusType::*|null */ private $status; /** * Status message such as "*Secret with this name already exists in this region*". + * + * @var string|null */ private $statusMessage; /** * The date that the secret was last accessed in the Region. This field is omitted if the secret has never been * retrieved in the Region. + * + * @var \DateTimeImmutable|null */ private $lastAccessedDate; diff --git a/src/Service/SecretsManager/src/ValueObject/RotationRulesType.php b/src/Service/SecretsManager/src/ValueObject/RotationRulesType.php index fa602a2f9..d5c088f36 100644 --- a/src/Service/SecretsManager/src/ValueObject/RotationRulesType.php +++ b/src/Service/SecretsManager/src/ValueObject/RotationRulesType.php @@ -16,6 +16,8 @@ final class RotationRulesType * In `DescribeSecret` and `ListSecrets`, this value is calculated from the rotation schedule after every successful * rotation. In `RotateSecret`, you can set the rotation schedule in `RotationRules` with `AutomaticallyAfterDays` or * `ScheduleExpression`, but not both. To set a rotation schedule in hours, use `ScheduleExpression`. + * + * @var int|null */ private $automaticallyAfterDays; @@ -28,6 +30,8 @@ final class RotationRulesType * expressions in Secrets Manager rotation [^1] in the *Secrets Manager Users Guide*. * * [^1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html + * + * @var string|null */ private $duration; @@ -50,6 +54,8 @@ final class RotationRulesType * the next UTC day or into the next rotation window. * * [^1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html + * + * @var string|null */ private $scheduleExpression; diff --git a/src/Service/SecretsManager/src/ValueObject/SecretListEntry.php b/src/Service/SecretsManager/src/ValueObject/SecretListEntry.php index c083ce982..c6e0cf979 100644 --- a/src/Service/SecretsManager/src/ValueObject/SecretListEntry.php +++ b/src/Service/SecretsManager/src/ValueObject/SecretListEntry.php @@ -12,6 +12,8 @@ final class SecretListEntry { /** * The Amazon Resource Name (ARN) of the secret. + * + * @var string|null */ private $arn; @@ -19,22 +21,30 @@ final class SecretListEntry * The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, * `/prod/databases/dbserver1` could represent the secret for a server named `dbserver1` in the folder `databases` in * the folder `prod`. + * + * @var string|null */ private $name; /** * The user-provided description of the secret. + * + * @var string|null */ private $description; /** * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the * Amazon Web Services managed key `aws/secretsmanager`, this field is omitted. + * + * @var string|null */ private $kmsKeyId; /** * Indicates whether automatic, scheduled rotation is enabled for this secret. + * + * @var bool|null */ private $rotationEnabled; @@ -43,28 +53,38 @@ final class SecretListEntry * automatically per the schedule or manually by a call to `RotateSecret` [^1]. * * [^1]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html + * + * @var string|null */ private $rotationLambdaArn; /** * A structure that defines the rotation configuration for the secret. + * + * @var RotationRulesType|null */ private $rotationRules; /** * The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is * null if the secret hasn't ever rotated. + * + * @var \DateTimeImmutable|null */ private $lastRotatedDate; /** * The last date and time that this secret was modified in any way. + * + * @var \DateTimeImmutable|null */ private $lastChangedDate; /** * The date that the secret was last accessed in the Region. This field is omitted if the secret has never been * retrieved in the Region. + * + * @var \DateTimeImmutable|null */ private $lastAccessedDate; @@ -74,12 +94,16 @@ final class SecretListEntry * the `DeleteSecret` [^1] operation. * * [^1]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html + * + * @var \DateTimeImmutable|null */ private $deletedDate; /** * The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets * Manager returns null. + * + * @var \DateTimeImmutable|null */ private $nextRotationDate; @@ -89,6 +113,8 @@ final class SecretListEntry * * [^1]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html * [^2]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UntagResource.html + * + * @var Tag[]|null */ private $tags; @@ -98,21 +124,29 @@ final class SecretListEntry * * > A version that does not have any `SecretVersionStage` is considered deprecated and subject to deletion. Such * > versions are not included in this list. + * + * @var array|null */ private $secretVersionsToStages; /** * Returns the name of the service that created the secret. + * + * @var string|null */ private $owningService; /** * The date and time when a secret was created. + * + * @var \DateTimeImmutable|null */ private $createdDate; /** * The Region where Secrets Manager originated the secret. + * + * @var string|null */ private $primaryRegion; diff --git a/src/Service/SecretsManager/src/ValueObject/Tag.php b/src/Service/SecretsManager/src/ValueObject/Tag.php index bbddb5fcd..e04d33031 100644 --- a/src/Service/SecretsManager/src/ValueObject/Tag.php +++ b/src/Service/SecretsManager/src/ValueObject/Tag.php @@ -9,11 +9,15 @@ final class Tag { /** * The key identifier, or name, of the tag. + * + * @var string|null */ private $key; /** * The string value associated with the key of the tag. + * + * @var string|null */ private $value; diff --git a/src/Service/Ses/src/Result/SendEmailResponse.php b/src/Service/Ses/src/Result/SendEmailResponse.php index b28df80f1..f405ff4e0 100644 --- a/src/Service/Ses/src/Result/SendEmailResponse.php +++ b/src/Service/Ses/src/Result/SendEmailResponse.php @@ -16,6 +16,8 @@ class SendEmailResponse extends Result * > It's possible for Amazon SES to accept a message without sending it. This can happen when the message that you're * > trying to send has an attachment contains a virus, or when you send a templated email that contains invalid * > personalization content, for example. + * + * @var string|null */ private $messageId; diff --git a/src/Service/Ses/src/ValueObject/Body.php b/src/Service/Ses/src/ValueObject/Body.php index 88eb54efc..191b2149c 100644 --- a/src/Service/Ses/src/ValueObject/Body.php +++ b/src/Service/Ses/src/ValueObject/Body.php @@ -10,12 +10,16 @@ final class Body /** * An object that represents the version of the message that is displayed in email clients that don't support HTML, or * clients where the recipient has disabled HTML rendering. + * + * @var Content|null */ private $text; /** * An object that represents the version of the message that is displayed in email clients that support HTML. HTML * messages can include formatted text, hyperlinks, images, and more. + * + * @var Content|null */ private $html; diff --git a/src/Service/Ses/src/ValueObject/Content.php b/src/Service/Ses/src/ValueObject/Content.php index e1982f823..3ebfd3244 100644 --- a/src/Service/Ses/src/ValueObject/Content.php +++ b/src/Service/Ses/src/ValueObject/Content.php @@ -11,6 +11,8 @@ final class Content { /** * The content of the message itself. + * + * @var string */ private $data; @@ -18,6 +20,8 @@ final class Content * The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by * default. If the text includes characters outside of the ASCII range, you have to specify a character set. For * example, you could specify `UTF-8`, `ISO-8859-1`, or `Shift_JIS`. + * + * @var string|null */ private $charset; diff --git a/src/Service/Ses/src/ValueObject/Destination.php b/src/Service/Ses/src/ValueObject/Destination.php index 5f84e7ac2..cd36223af 100644 --- a/src/Service/Ses/src/ValueObject/Destination.php +++ b/src/Service/Ses/src/ValueObject/Destination.php @@ -18,16 +18,22 @@ final class Destination { /** * An array that contains the email addresses of the "To" recipients for the email. + * + * @var string[]|null */ private $toAddresses; /** * An array that contains the email addresses of the "CC" (carbon copy) recipients for the email. + * + * @var string[]|null */ private $ccAddresses; /** * An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email. + * + * @var string[]|null */ private $bccAddresses; diff --git a/src/Service/Ses/src/ValueObject/EmailContent.php b/src/Service/Ses/src/ValueObject/EmailContent.php index 6ab7d78c1..f034bb1e5 100644 --- a/src/Service/Ses/src/ValueObject/EmailContent.php +++ b/src/Service/Ses/src/ValueObject/EmailContent.php @@ -12,6 +12,8 @@ final class EmailContent { /** * The simple email message. The message consists of a subject and a message body. + * + * @var Message|null */ private $simple; @@ -29,11 +31,15 @@ final class EmailContent * RFC 5321 [^1]. * * [^1]: https://tools.ietf.org/html/rfc5321 + * + * @var RawMessage|null */ private $raw; /** * The template to use for the email message. + * + * @var Template|null */ private $template; diff --git a/src/Service/Ses/src/ValueObject/ListManagementOptions.php b/src/Service/Ses/src/ValueObject/ListManagementOptions.php index 4eb235b35..eaa241679 100644 --- a/src/Service/Ses/src/ValueObject/ListManagementOptions.php +++ b/src/Service/Ses/src/ValueObject/ListManagementOptions.php @@ -12,11 +12,15 @@ final class ListManagementOptions { /** * The name of the contact list. + * + * @var string */ private $contactListName; /** * The name of the topic. + * + * @var string|null */ private $topicName; diff --git a/src/Service/Ses/src/ValueObject/Message.php b/src/Service/Ses/src/ValueObject/Message.php index 0435e39ef..a18d340b7 100644 --- a/src/Service/Ses/src/ValueObject/Message.php +++ b/src/Service/Ses/src/ValueObject/Message.php @@ -14,11 +14,15 @@ final class Message * non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047 [^1]. * * [^1]: https://tools.ietf.org/html/rfc2047 + * + * @var Content */ private $subject; /** * The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both. + * + * @var Body */ private $body; diff --git a/src/Service/Ses/src/ValueObject/MessageTag.php b/src/Service/Ses/src/ValueObject/MessageTag.php index b94c8d53e..65d19e5eb 100644 --- a/src/Service/Ses/src/ValueObject/MessageTag.php +++ b/src/Service/Ses/src/ValueObject/MessageTag.php @@ -15,6 +15,8 @@ final class MessageTag * * - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). * - It can contain no more than 256 characters. + * + * @var string */ private $name; @@ -23,6 +25,8 @@ final class MessageTag * * - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). * - It can contain no more than 256 characters. + * + * @var string */ private $value; diff --git a/src/Service/Ses/src/ValueObject/RawMessage.php b/src/Service/Ses/src/ValueObject/RawMessage.php index 746c6c5db..4fab19300 100644 --- a/src/Service/Ses/src/ValueObject/RawMessage.php +++ b/src/Service/Ses/src/ValueObject/RawMessage.php @@ -23,6 +23,8 @@ final class RawMessage * RFC 5321 [^1]. * * [^1]: https://tools.ietf.org/html/rfc5321 + * + * @var string */ private $data; diff --git a/src/Service/Ses/src/ValueObject/Template.php b/src/Service/Ses/src/ValueObject/Template.php index 13774bb7b..fc7d6d2b8 100644 --- a/src/Service/Ses/src/ValueObject/Template.php +++ b/src/Service/Ses/src/ValueObject/Template.php @@ -12,11 +12,15 @@ final class Template /** * The name of the template. You will refer to this name when you send email using the `SendTemplatedEmail` or * `SendBulkTemplatedEmail` operations. + * + * @var string|null */ private $templateName; /** * The Amazon Resource Name (ARN) of the template. + * + * @var string|null */ private $templateArn; @@ -24,6 +28,8 @@ final class Template * An object that defines the values to use for message variables in the template. This object is a set of key-value * pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that * variable. + * + * @var string|null */ private $templateData; diff --git a/src/Service/Sns/src/Result/CreateEndpointResponse.php b/src/Service/Sns/src/Result/CreateEndpointResponse.php index 0e3673cad..2aac668a4 100644 --- a/src/Service/Sns/src/Result/CreateEndpointResponse.php +++ b/src/Service/Sns/src/Result/CreateEndpointResponse.php @@ -12,6 +12,8 @@ class CreateEndpointResponse extends Result { /** * EndpointArn returned from CreateEndpoint action. + * + * @var string|null */ private $endpointArn; diff --git a/src/Service/Sns/src/Result/CreateTopicResponse.php b/src/Service/Sns/src/Result/CreateTopicResponse.php index eb473d78f..cfe7fe0e1 100644 --- a/src/Service/Sns/src/Result/CreateTopicResponse.php +++ b/src/Service/Sns/src/Result/CreateTopicResponse.php @@ -12,6 +12,8 @@ class CreateTopicResponse extends Result { /** * The Amazon Resource Name (ARN) assigned to the created topic. + * + * @var string|null */ private $topicArn; diff --git a/src/Service/Sns/src/Result/ListSubscriptionsByTopicResponse.php b/src/Service/Sns/src/Result/ListSubscriptionsByTopicResponse.php index 1b393f05a..f20482143 100644 --- a/src/Service/Sns/src/Result/ListSubscriptionsByTopicResponse.php +++ b/src/Service/Sns/src/Result/ListSubscriptionsByTopicResponse.php @@ -18,12 +18,16 @@ class ListSubscriptionsByTopicResponse extends Result implements \IteratorAggreg { /** * A list of subscriptions. + * + * @var Subscription[] */ private $subscriptions; /** * Token to pass along to the next `ListSubscriptionsByTopic` request. This element is returned if there are more * subscriptions to retrieve. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Sns/src/Result/PublishBatchResponse.php b/src/Service/Sns/src/Result/PublishBatchResponse.php index 93d8483f3..115681965 100644 --- a/src/Service/Sns/src/Result/PublishBatchResponse.php +++ b/src/Service/Sns/src/Result/PublishBatchResponse.php @@ -11,11 +11,15 @@ class PublishBatchResponse extends Result { /** * A list of successful `PublishBatch` responses. + * + * @var PublishBatchResultEntry[] */ private $successful; /** * A list of failed `PublishBatch` responses. + * + * @var BatchResultErrorEntry[] */ private $failed; diff --git a/src/Service/Sns/src/Result/PublishResponse.php b/src/Service/Sns/src/Result/PublishResponse.php index d82935008..5f8049f14 100644 --- a/src/Service/Sns/src/Result/PublishResponse.php +++ b/src/Service/Sns/src/Result/PublishResponse.php @@ -14,6 +14,8 @@ class PublishResponse extends Result * Unique identifier assigned to the published message. * * Length Constraint: Maximum 100 characters + * + * @var string|null */ private $messageId; @@ -22,6 +24,8 @@ class PublishResponse extends Result * * The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of * `SequenceNumber` is 128 bits. `SequenceNumber` continues to increase for each `MessageGroupId`. + * + * @var string|null */ private $sequenceNumber; diff --git a/src/Service/Sns/src/Result/SubscribeResponse.php b/src/Service/Sns/src/Result/SubscribeResponse.php index e6c8520fe..d56ae7f2b 100644 --- a/src/Service/Sns/src/Result/SubscribeResponse.php +++ b/src/Service/Sns/src/Result/SubscribeResponse.php @@ -14,6 +14,8 @@ class SubscribeResponse extends Result * The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires * confirmation. However, if the API request parameter `ReturnSubscriptionArn` is true, then the value is always the * subscription ARN, even if the subscription requires confirmation. + * + * @var string|null */ private $subscriptionArn; diff --git a/src/Service/Sns/src/ValueObject/BatchResultErrorEntry.php b/src/Service/Sns/src/ValueObject/BatchResultErrorEntry.php index 989a2b137..ad7d5407d 100644 --- a/src/Service/Sns/src/ValueObject/BatchResultErrorEntry.php +++ b/src/Service/Sns/src/ValueObject/BatchResultErrorEntry.php @@ -11,21 +11,29 @@ final class BatchResultErrorEntry { /** * The `Id` of an entry in a batch request. + * + * @var string */ private $id; /** * An error code representing why the action failed on this entry. + * + * @var string */ private $code; /** * A message explaining why the action failed on this entry. + * + * @var string|null */ private $message; /** * Specifies whether the error happened due to the caller of the batch API action. + * + * @var bool */ private $senderFault; diff --git a/src/Service/Sns/src/ValueObject/MessageAttributeValue.php b/src/Service/Sns/src/ValueObject/MessageAttributeValue.php index d418d8686..a008d5deb 100644 --- a/src/Service/Sns/src/ValueObject/MessageAttributeValue.php +++ b/src/Service/Sns/src/ValueObject/MessageAttributeValue.php @@ -24,6 +24,8 @@ final class MessageAttributeValue * see Message Attribute Data Types [^1]. * * [^1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes + * + * @var string */ private $dataType; @@ -31,11 +33,15 @@ final class MessageAttributeValue * Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters [^1]. * * [^1]: https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters + * + * @var string|null */ private $stringValue; /** * Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. + * + * @var string|null */ private $binaryValue; diff --git a/src/Service/Sns/src/ValueObject/PublishBatchRequestEntry.php b/src/Service/Sns/src/ValueObject/PublishBatchRequestEntry.php index 8f692d54d..8c8c96e39 100644 --- a/src/Service/Sns/src/ValueObject/PublishBatchRequestEntry.php +++ b/src/Service/Sns/src/ValueObject/PublishBatchRequestEntry.php @@ -16,16 +16,22 @@ final class PublishBatchRequestEntry * > * > This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, * > hyphens(-), and underscores (_). + * + * @var string */ private $id; /** * The body of the message. + * + * @var string */ private $message; /** * The subject of the batch message. + * + * @var string|null */ private $subject; @@ -39,6 +45,8 @@ final class PublishBatchRequestEntry * * You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. * http). + * + * @var string|null */ private $messageStructure; @@ -47,6 +55,8 @@ final class PublishBatchRequestEntry * attributes [^1] in the Amazon SNS Developer Guide. * * [^1]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html + * + * @var array|null */ private $messageAttributes; @@ -85,6 +95,8 @@ final class PublishBatchRequestEntry * * `MessageDeduplicationId` can contain alphanumeric characters `(a-z, A-Z, 0-9)` and punctuation * `(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)`. + * + * @var string|null */ private $messageDeduplicationId; @@ -106,6 +118,8 @@ final class PublishBatchRequestEntry * `(!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)`. * * ! `MessageGroupId` is required for FIFO topics. You can't use it for standard topics. + * + * @var string|null */ private $messageGroupId; diff --git a/src/Service/Sns/src/ValueObject/PublishBatchResultEntry.php b/src/Service/Sns/src/ValueObject/PublishBatchResultEntry.php index 1e2ebe10b..fc2d3cf5f 100644 --- a/src/Service/Sns/src/ValueObject/PublishBatchResultEntry.php +++ b/src/Service/Sns/src/ValueObject/PublishBatchResultEntry.php @@ -9,11 +9,15 @@ final class PublishBatchResultEntry { /** * The `Id` of an entry in a batch request. + * + * @var string|null */ private $id; /** * An identifier for the message. + * + * @var string|null */ private $messageId; @@ -23,6 +27,8 @@ final class PublishBatchResultEntry * The large, non-consecutive number that Amazon SNS assigns to each message. * * The length of `SequenceNumber` is 128 bits. `SequenceNumber` continues to increase for a particular `MessageGroupId`. + * + * @var string|null */ private $sequenceNumber; diff --git a/src/Service/Sns/src/ValueObject/Subscription.php b/src/Service/Sns/src/ValueObject/Subscription.php index 5ca831f8e..4c21834bb 100644 --- a/src/Service/Sns/src/ValueObject/Subscription.php +++ b/src/Service/Sns/src/ValueObject/Subscription.php @@ -9,26 +9,36 @@ final class Subscription { /** * The subscription's ARN. + * + * @var string|null */ private $subscriptionArn; /** * The subscription's owner. + * + * @var string|null */ private $owner; /** * The subscription's protocol. + * + * @var string|null */ private $protocol; /** * The subscription's endpoint (format depends on the protocol). + * + * @var string|null */ private $endpoint; /** * The ARN of the subscription's topic. + * + * @var string|null */ private $topicArn; diff --git a/src/Service/Sns/src/ValueObject/Tag.php b/src/Service/Sns/src/ValueObject/Tag.php index d4d6527d8..82d4b92e2 100644 --- a/src/Service/Sns/src/ValueObject/Tag.php +++ b/src/Service/Sns/src/ValueObject/Tag.php @@ -11,11 +11,15 @@ final class Tag { /** * The required key portion of the tag. + * + * @var string */ private $key; /** * The optional value portion of the tag. + * + * @var string */ private $value; diff --git a/src/Service/Sqs/src/Result/ChangeMessageVisibilityBatchResult.php b/src/Service/Sqs/src/Result/ChangeMessageVisibilityBatchResult.php index bdea01d06..7536998d2 100644 --- a/src/Service/Sqs/src/Result/ChangeMessageVisibilityBatchResult.php +++ b/src/Service/Sqs/src/Result/ChangeMessageVisibilityBatchResult.php @@ -15,11 +15,15 @@ class ChangeMessageVisibilityBatchResult extends Result { /** * A list of `ChangeMessageVisibilityBatchResultEntry` items. + * + * @var ChangeMessageVisibilityBatchResultEntry[] */ private $successful; /** * A list of `BatchResultErrorEntry` items. + * + * @var BatchResultErrorEntry[] */ private $failed; diff --git a/src/Service/Sqs/src/Result/CreateQueueResult.php b/src/Service/Sqs/src/Result/CreateQueueResult.php index 37f9a4170..d29e5571d 100644 --- a/src/Service/Sqs/src/Result/CreateQueueResult.php +++ b/src/Service/Sqs/src/Result/CreateQueueResult.php @@ -12,6 +12,8 @@ class CreateQueueResult extends Result { /** * The URL of the created Amazon SQS queue. + * + * @var string|null */ private $queueUrl; diff --git a/src/Service/Sqs/src/Result/DeleteMessageBatchResult.php b/src/Service/Sqs/src/Result/DeleteMessageBatchResult.php index 79c06deaf..c447a9db6 100644 --- a/src/Service/Sqs/src/Result/DeleteMessageBatchResult.php +++ b/src/Service/Sqs/src/Result/DeleteMessageBatchResult.php @@ -15,11 +15,15 @@ class DeleteMessageBatchResult extends Result { /** * A list of `DeleteMessageBatchResultEntry` items. + * + * @var DeleteMessageBatchResultEntry[] */ private $successful; /** * A list of `BatchResultErrorEntry` items. + * + * @var BatchResultErrorEntry[] */ private $failed; diff --git a/src/Service/Sqs/src/Result/GetQueueAttributesResult.php b/src/Service/Sqs/src/Result/GetQueueAttributesResult.php index ab7d0fa99..60c690ef6 100644 --- a/src/Service/Sqs/src/Result/GetQueueAttributesResult.php +++ b/src/Service/Sqs/src/Result/GetQueueAttributesResult.php @@ -13,6 +13,8 @@ class GetQueueAttributesResult extends Result { /** * A map of attributes to their respective values. + * + * @var array */ private $attributes; diff --git a/src/Service/Sqs/src/Result/GetQueueUrlResult.php b/src/Service/Sqs/src/Result/GetQueueUrlResult.php index 119feade3..c500d0c78 100644 --- a/src/Service/Sqs/src/Result/GetQueueUrlResult.php +++ b/src/Service/Sqs/src/Result/GetQueueUrlResult.php @@ -14,6 +14,8 @@ class GetQueueUrlResult extends Result { /** * The URL of the queue. + * + * @var string|null */ private $queueUrl; diff --git a/src/Service/Sqs/src/Result/ListQueuesResult.php b/src/Service/Sqs/src/Result/ListQueuesResult.php index 88096d584..3ade0cc39 100644 --- a/src/Service/Sqs/src/Result/ListQueuesResult.php +++ b/src/Service/Sqs/src/Result/ListQueuesResult.php @@ -17,12 +17,16 @@ class ListQueuesResult extends Result implements \IteratorAggregate { /** * A list of queue URLs, up to 1,000 entries, or the value of `MaxResults` that you sent in the request. + * + * @var string[] */ private $queueUrls; /** * Pagination token to include in the next request. Token value is `null` if there are no additional results to request, * or if you did not set `MaxResults` in the request. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Sqs/src/Result/ReceiveMessageResult.php b/src/Service/Sqs/src/Result/ReceiveMessageResult.php index 724d03e5b..8896f38ff 100644 --- a/src/Service/Sqs/src/Result/ReceiveMessageResult.php +++ b/src/Service/Sqs/src/Result/ReceiveMessageResult.php @@ -15,6 +15,8 @@ class ReceiveMessageResult extends Result { /** * A list of messages. + * + * @var Message[] */ private $messages; diff --git a/src/Service/Sqs/src/Result/SendMessageBatchResult.php b/src/Service/Sqs/src/Result/SendMessageBatchResult.php index 9234cdb80..b075273ec 100644 --- a/src/Service/Sqs/src/Result/SendMessageBatchResult.php +++ b/src/Service/Sqs/src/Result/SendMessageBatchResult.php @@ -15,11 +15,15 @@ class SendMessageBatchResult extends Result { /** * A list of `SendMessageBatchResultEntry` items. + * + * @var SendMessageBatchResultEntry[] */ private $successful; /** * A list of `BatchResultErrorEntry` items with error details about each message that can't be enqueued. + * + * @var BatchResultErrorEntry[] */ private $failed; diff --git a/src/Service/Sqs/src/Result/SendMessageResult.php b/src/Service/Sqs/src/Result/SendMessageResult.php index 4bc6c9d85..3f945a1fe 100644 --- a/src/Service/Sqs/src/Result/SendMessageResult.php +++ b/src/Service/Sqs/src/Result/SendMessageResult.php @@ -16,6 +16,8 @@ class SendMessageResult extends Result * about MD5, see RFC1321 [^1]. * * [^1]: https://www.ietf.org/rfc/rfc1321.txt + * + * @var string|null */ private $md5OfMessageBody; @@ -25,12 +27,16 @@ class SendMessageResult extends Result * about MD5, see RFC1321 [^1]. * * [^1]: https://www.ietf.org/rfc/rfc1321.txt + * + * @var string|null */ private $md5OfMessageAttributes; /** * An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that * Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. + * + * @var string|null */ private $md5OfMessageSystemAttributes; @@ -39,6 +45,8 @@ class SendMessageResult extends Result * Identifiers [^1] in the *Amazon SQS Developer Guide*. * * [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html + * + * @var string|null */ private $messageId; @@ -48,6 +56,8 @@ class SendMessageResult extends Result * The large, non-consecutive number that Amazon SQS assigns to each message. * * The length of `SequenceNumber` is 128 bits. `SequenceNumber` continues to increase for a particular `MessageGroupId`. + * + * @var string|null */ private $sequenceNumber; diff --git a/src/Service/Sqs/src/ValueObject/BatchResultErrorEntry.php b/src/Service/Sqs/src/ValueObject/BatchResultErrorEntry.php index 1ffbc8c74..96507f3af 100644 --- a/src/Service/Sqs/src/ValueObject/BatchResultErrorEntry.php +++ b/src/Service/Sqs/src/ValueObject/BatchResultErrorEntry.php @@ -11,21 +11,29 @@ final class BatchResultErrorEntry { /** * The `Id` of an entry in a batch request. + * + * @var string */ private $id; /** * Specifies whether the error happened due to the caller of the batch API action. + * + * @var bool */ private $senderFault; /** * An error code representing why the action failed on this entry. + * + * @var string */ private $code; /** * A message explaining why the action failed on this entry. + * + * @var string|null */ private $message; diff --git a/src/Service/Sqs/src/ValueObject/ChangeMessageVisibilityBatchRequestEntry.php b/src/Service/Sqs/src/ValueObject/ChangeMessageVisibilityBatchRequestEntry.php index 4804170a9..e03b7336c 100644 --- a/src/Service/Sqs/src/ValueObject/ChangeMessageVisibilityBatchRequestEntry.php +++ b/src/Service/Sqs/src/ValueObject/ChangeMessageVisibilityBatchRequestEntry.php @@ -16,16 +16,22 @@ final class ChangeMessageVisibilityBatchRequestEntry * > * > This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, * > hyphens(-), and underscores (_). + * + * @var string */ private $id; /** * A receipt handle. + * + * @var string */ private $receiptHandle; /** * The new value (in seconds) for the message's visibility timeout. + * + * @var int|null */ private $visibilityTimeout; diff --git a/src/Service/Sqs/src/ValueObject/ChangeMessageVisibilityBatchResultEntry.php b/src/Service/Sqs/src/ValueObject/ChangeMessageVisibilityBatchResultEntry.php index 97f7680c0..893f03509 100644 --- a/src/Service/Sqs/src/ValueObject/ChangeMessageVisibilityBatchResultEntry.php +++ b/src/Service/Sqs/src/ValueObject/ChangeMessageVisibilityBatchResultEntry.php @@ -11,6 +11,8 @@ final class ChangeMessageVisibilityBatchResultEntry { /** * Represents a message whose visibility timeout has been changed successfully. + * + * @var string */ private $id; diff --git a/src/Service/Sqs/src/ValueObject/DeleteMessageBatchRequestEntry.php b/src/Service/Sqs/src/ValueObject/DeleteMessageBatchRequestEntry.php index cb668b17a..17b7f029c 100644 --- a/src/Service/Sqs/src/ValueObject/DeleteMessageBatchRequestEntry.php +++ b/src/Service/Sqs/src/ValueObject/DeleteMessageBatchRequestEntry.php @@ -16,11 +16,15 @@ final class DeleteMessageBatchRequestEntry * > * > This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, * > hyphens(-), and underscores (_). + * + * @var string */ private $id; /** * A receipt handle. + * + * @var string */ private $receiptHandle; diff --git a/src/Service/Sqs/src/ValueObject/DeleteMessageBatchResultEntry.php b/src/Service/Sqs/src/ValueObject/DeleteMessageBatchResultEntry.php index 4bc4a8842..a15d406c7 100644 --- a/src/Service/Sqs/src/ValueObject/DeleteMessageBatchResultEntry.php +++ b/src/Service/Sqs/src/ValueObject/DeleteMessageBatchResultEntry.php @@ -11,6 +11,8 @@ final class DeleteMessageBatchResultEntry { /** * Represents a successfully deleted message. + * + * @var string */ private $id; diff --git a/src/Service/Sqs/src/ValueObject/Message.php b/src/Service/Sqs/src/ValueObject/Message.php index 4d1c133f7..25daafddc 100644 --- a/src/Service/Sqs/src/ValueObject/Message.php +++ b/src/Service/Sqs/src/ValueObject/Message.php @@ -12,22 +12,30 @@ final class Message /** * A unique identifier for the message. A `MessageId`is considered unique across all Amazon Web Services accounts for an * extended period of time. + * + * @var string|null */ private $messageId; /** * An identifier associated with the act of receiving the message. A new receipt handle is returned every time you * receive a message. When deleting a message, you provide the last received receipt handle to delete the message. + * + * @var string|null */ private $receiptHandle; /** * An MD5 digest of the non-URL-encoded message body string. + * + * @var string|null */ private $md5OfBody; /** * The message's contents (not URL-encoded). + * + * @var string|null */ private $body; @@ -46,6 +54,8 @@ final class Message * [^1] in milliseconds. * * [^1]: http://en.wikipedia.org/wiki/Unix_time + * + * @var array|null */ private $attributes; @@ -55,6 +65,8 @@ final class Message * about MD5, see RFC1321 [^1]. * * [^1]: https://www.ietf.org/rfc/rfc1321.txt + * + * @var string|null */ private $md5OfMessageAttributes; @@ -63,6 +75,8 @@ final class Message * attributes [^1] in the *Amazon SQS Developer Guide*. * * [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes + * + * @var array|null */ private $messageAttributes; diff --git a/src/Service/Sqs/src/ValueObject/MessageAttributeValue.php b/src/Service/Sqs/src/ValueObject/MessageAttributeValue.php index e10d6dd3b..f8ef25ac4 100644 --- a/src/Service/Sqs/src/ValueObject/MessageAttributeValue.php +++ b/src/Service/Sqs/src/ValueObject/MessageAttributeValue.php @@ -17,21 +17,29 @@ final class MessageAttributeValue * Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters [^1]. * * [^1]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters + * + * @var string|null */ private $stringValue; /** * Binary type attributes can store any binary data, such as compressed data, encrypted data, or images. + * + * @var string|null */ private $binaryValue; /** * Not implemented. Reserved for future use. + * + * @var string[]|null */ private $stringListValues; /** * Not implemented. Reserved for future use. + * + * @var string[]|null */ private $binaryListValues; @@ -43,6 +51,8 @@ final class MessageAttributeValue * Developer Guide*. * * [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes + * + * @var string */ private $dataType; diff --git a/src/Service/Sqs/src/ValueObject/MessageSystemAttributeValue.php b/src/Service/Sqs/src/ValueObject/MessageSystemAttributeValue.php index fa51bae10..b85eb7ea6 100644 --- a/src/Service/Sqs/src/ValueObject/MessageSystemAttributeValue.php +++ b/src/Service/Sqs/src/ValueObject/MessageSystemAttributeValue.php @@ -16,21 +16,29 @@ final class MessageSystemAttributeValue * Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters [^1]. * * [^1]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters + * + * @var string|null */ private $stringValue; /** * Binary type attributes can store any binary data, such as compressed data, encrypted data, or images. + * + * @var string|null */ private $binaryValue; /** * Not implemented. Reserved for future use. + * + * @var string[]|null */ private $stringListValues; /** * Not implemented. Reserved for future use. + * + * @var string[]|null */ private $binaryListValues; @@ -42,6 +50,8 @@ final class MessageSystemAttributeValue * Developer Guide*. * * [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes + * + * @var string */ private $dataType; diff --git a/src/Service/Sqs/src/ValueObject/SendMessageBatchRequestEntry.php b/src/Service/Sqs/src/ValueObject/SendMessageBatchRequestEntry.php index 18c05f59f..f47c80112 100644 --- a/src/Service/Sqs/src/ValueObject/SendMessageBatchRequestEntry.php +++ b/src/Service/Sqs/src/ValueObject/SendMessageBatchRequestEntry.php @@ -17,11 +17,15 @@ final class SendMessageBatchRequestEntry * > * > This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, * > hyphens(-), and underscores (_). + * + * @var string */ private $id; /** * The body of the message. + * + * @var string */ private $messageBody; @@ -32,6 +36,8 @@ final class SendMessageBatchRequestEntry * * > When you set `FifoQueue`, you can't set `DelaySeconds` per message. You can set this parameter only on a queue * > level. + * + * @var int|null */ private $delaySeconds; @@ -40,6 +46,8 @@ final class SendMessageBatchRequestEntry * attributes [^1] in the *Amazon SQS Developer Guide*. * * [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes + * + * @var array|null */ private $messageAttributes; @@ -50,6 +58,8 @@ final class SendMessageBatchRequestEntry * ! value must be a correctly formatted X-Ray trace header string. * ! - The size of a message system attribute doesn't count towards the total size of a message. * ! + * + * @var array|null */ private $messageSystemAttributes; @@ -93,6 +103,8 @@ final class SendMessageBatchRequestEntry * * [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html * [^2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html + * + * @var string|null */ private $messageDeduplicationId; @@ -119,6 +131,8 @@ final class SendMessageBatchRequestEntry * ! `MessageGroupId` is required for FIFO queues. You can't use it for Standard queues. * * [^1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html + * + * @var string|null */ private $messageGroupId; diff --git a/src/Service/Sqs/src/ValueObject/SendMessageBatchResultEntry.php b/src/Service/Sqs/src/ValueObject/SendMessageBatchResultEntry.php index 15c65d816..4de0eadc6 100644 --- a/src/Service/Sqs/src/ValueObject/SendMessageBatchResultEntry.php +++ b/src/Service/Sqs/src/ValueObject/SendMessageBatchResultEntry.php @@ -11,11 +11,15 @@ final class SendMessageBatchResultEntry { /** * An identifier for the message in this batch. + * + * @var string */ private $id; /** * An identifier for the message. + * + * @var string */ private $messageId; @@ -25,6 +29,8 @@ final class SendMessageBatchResultEntry * about MD5, see RFC1321 [^1]. * * [^1]: https://www.ietf.org/rfc/rfc1321.txt + * + * @var string */ private $md5OfMessageBody; @@ -34,6 +40,8 @@ final class SendMessageBatchResultEntry * about MD5, see RFC1321 [^1]. * * [^1]: https://www.ietf.org/rfc/rfc1321.txt + * + * @var string|null */ private $md5OfMessageAttributes; @@ -43,6 +51,8 @@ final class SendMessageBatchResultEntry * information about MD5, see RFC1321 [^1]. * * [^1]: https://www.ietf.org/rfc/rfc1321.txt + * + * @var string|null */ private $md5OfMessageSystemAttributes; @@ -53,6 +63,8 @@ final class SendMessageBatchResultEntry * * The length of `SequenceNumber` is 128 bits. As `SequenceNumber` continues to increase for a particular * `MessageGroupId`. + * + * @var string|null */ private $sequenceNumber; diff --git a/src/Service/Ssm/src/Result/DeleteParametersResult.php b/src/Service/Ssm/src/Result/DeleteParametersResult.php index 434d2cfc0..2925f1e2d 100644 --- a/src/Service/Ssm/src/Result/DeleteParametersResult.php +++ b/src/Service/Ssm/src/Result/DeleteParametersResult.php @@ -9,11 +9,15 @@ class DeleteParametersResult extends Result { /** * The names of the deleted parameters. + * + * @var string[] */ private $deletedParameters; /** * The names of parameters that weren't deleted because the parameters aren't valid. + * + * @var string[] */ private $invalidParameters; diff --git a/src/Service/Ssm/src/Result/GetParameterResult.php b/src/Service/Ssm/src/Result/GetParameterResult.php index c72a381ac..730d1d2ac 100644 --- a/src/Service/Ssm/src/Result/GetParameterResult.php +++ b/src/Service/Ssm/src/Result/GetParameterResult.php @@ -10,6 +10,8 @@ class GetParameterResult extends Result { /** * Information about a parameter. + * + * @var Parameter|null */ private $parameter; diff --git a/src/Service/Ssm/src/Result/GetParametersByPathResult.php b/src/Service/Ssm/src/Result/GetParametersByPathResult.php index 27c2b4749..4327dd102 100644 --- a/src/Service/Ssm/src/Result/GetParametersByPathResult.php +++ b/src/Service/Ssm/src/Result/GetParametersByPathResult.php @@ -16,11 +16,15 @@ class GetParametersByPathResult extends Result implements \IteratorAggregate { /** * A list of parameters found in the specified hierarchy. + * + * @var Parameter[] */ private $parameters; /** * The token for the next set of items to return. Use this token to get the next set of results. + * + * @var string|null */ private $nextToken; diff --git a/src/Service/Ssm/src/Result/GetParametersResult.php b/src/Service/Ssm/src/Result/GetParametersResult.php index 0ba48b155..3e73945fc 100644 --- a/src/Service/Ssm/src/Result/GetParametersResult.php +++ b/src/Service/Ssm/src/Result/GetParametersResult.php @@ -10,11 +10,15 @@ class GetParametersResult extends Result { /** * A list of details for a parameter. + * + * @var Parameter[] */ private $parameters; /** * A list of parameters that aren't formatted correctly or don't run during an execution. + * + * @var string[] */ private $invalidParameters; diff --git a/src/Service/Ssm/src/Result/PutParameterResult.php b/src/Service/Ssm/src/Result/PutParameterResult.php index 33869bcb8..59238b195 100644 --- a/src/Service/Ssm/src/Result/PutParameterResult.php +++ b/src/Service/Ssm/src/Result/PutParameterResult.php @@ -13,11 +13,15 @@ class PutParameterResult extends Result * version and assigns this new version a unique ID. You can reference a parameter version ID in API operations or in * Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns * the latest parameter value when a parameter is called. + * + * @var int|null */ private $version; /** * The tier assigned to the parameter. + * + * @var ParameterTier::*|null */ private $tier; diff --git a/src/Service/Ssm/src/ValueObject/Parameter.php b/src/Service/Ssm/src/ValueObject/Parameter.php index da6e9b7f2..d2ef51754 100644 --- a/src/Service/Ssm/src/ValueObject/Parameter.php +++ b/src/Service/Ssm/src/ValueObject/Parameter.php @@ -11,6 +11,8 @@ final class Parameter { /** * The name of the parameter. + * + * @var string|null */ private $name; @@ -19,6 +21,8 @@ final class Parameter * * > If type is `StringList`, the system returns a comma-separated string with no spaces between commas in the `Value` * > field. + * + * @var ParameterType::*|null */ private $type; @@ -27,11 +31,15 @@ final class Parameter * * > If type is `StringList`, the system returns a comma-separated string with no spaces between commas in the `Value` * > field. + * + * @var string|null */ private $value; /** * The parameter version. + * + * @var int|null */ private $version; @@ -42,27 +50,37 @@ final class Parameter * parameter_name:version * * parameter_name:label + * + * @var string|null */ private $selector; /** * Applies to parameters that reference information in other Amazon Web Services services. `SourceResult` is the raw * result or response from the source. + * + * @var string|null */ private $sourceResult; /** * Date the parameter was last changed or updated and the parameter version was created. + * + * @var \DateTimeImmutable|null */ private $lastModifiedDate; /** * The Amazon Resource Name (ARN) of the parameter. + * + * @var string|null */ private $arn; /** * The data type of the parameter, such as `text` or `aws:ec2:image`. The default is `text`. + * + * @var string|null */ private $dataType; diff --git a/src/Service/Ssm/src/ValueObject/ParameterStringFilter.php b/src/Service/Ssm/src/ValueObject/ParameterStringFilter.php index a694c6b5a..2d712a735 100644 --- a/src/Service/Ssm/src/ValueObject/ParameterStringFilter.php +++ b/src/Service/Ssm/src/ValueObject/ParameterStringFilter.php @@ -24,6 +24,8 @@ final class ParameterStringFilter * for Systems Manager parameters [^1] in the *Amazon Web Services Systems Manager User Guide*. * * [^1]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html + * + * @var string */ private $key; @@ -34,11 +36,15 @@ final class ParameterStringFilter * * For filters used with GetParametersByPath, valid options include `Equals` and `BeginsWith`. (Exception: For filters * using `Label` as the Key name, the only valid option is `Equals`.) + * + * @var string|null */ private $option; /** * The value you want to search for. + * + * @var string[]|null */ private $values; diff --git a/src/Service/Ssm/src/ValueObject/Tag.php b/src/Service/Ssm/src/ValueObject/Tag.php index 5ff2f1424..b809bc63f 100644 --- a/src/Service/Ssm/src/ValueObject/Tag.php +++ b/src/Service/Ssm/src/ValueObject/Tag.php @@ -14,11 +14,15 @@ final class Tag { /** * The name of the tag. + * + * @var string */ private $key; /** * The value of the tag. + * + * @var string */ private $value; diff --git a/src/Service/StepFunctions/src/Exception/ValidationException.php b/src/Service/StepFunctions/src/Exception/ValidationException.php index 193ed1d2b..9abca4292 100644 --- a/src/Service/StepFunctions/src/Exception/ValidationException.php +++ b/src/Service/StepFunctions/src/Exception/ValidationException.php @@ -13,6 +13,8 @@ final class ValidationException extends ClientException { /** * The input does not satisfy the constraints specified by an Amazon Web Services service. + * + * @var ValidationExceptionReason::*|null */ private $reason; diff --git a/src/Service/StepFunctions/src/Result/StartExecutionOutput.php b/src/Service/StepFunctions/src/Result/StartExecutionOutput.php index 798d2cea4..46ae5873f 100644 --- a/src/Service/StepFunctions/src/Result/StartExecutionOutput.php +++ b/src/Service/StepFunctions/src/Result/StartExecutionOutput.php @@ -9,11 +9,15 @@ class StartExecutionOutput extends Result { /** * The Amazon Resource Name (ARN) that identifies the execution. + * + * @var string */ private $executionArn; /** * The date the execution is started. + * + * @var \DateTimeImmutable */ private $startDate; diff --git a/src/Service/StepFunctions/src/Result/StopExecutionOutput.php b/src/Service/StepFunctions/src/Result/StopExecutionOutput.php index 8ba31f3a8..860166b47 100644 --- a/src/Service/StepFunctions/src/Result/StopExecutionOutput.php +++ b/src/Service/StepFunctions/src/Result/StopExecutionOutput.php @@ -9,6 +9,8 @@ class StopExecutionOutput extends Result { /** * The date the execution is stopped. + * + * @var \DateTimeImmutable */ private $stopDate; diff --git a/src/Service/TimestreamQuery/src/Result/CancelQueryResponse.php b/src/Service/TimestreamQuery/src/Result/CancelQueryResponse.php index 2abce6c2e..69bc35978 100644 --- a/src/Service/TimestreamQuery/src/Result/CancelQueryResponse.php +++ b/src/Service/TimestreamQuery/src/Result/CancelQueryResponse.php @@ -10,6 +10,8 @@ class CancelQueryResponse extends Result /** * A `CancellationMessage` is returned when a `CancelQuery` request for the query specified by `QueryId` has already * been issued. + * + * @var string|null */ private $cancellationMessage; diff --git a/src/Service/TimestreamQuery/src/Result/DescribeEndpointsResponse.php b/src/Service/TimestreamQuery/src/Result/DescribeEndpointsResponse.php index 64652401f..7eee0b3b6 100644 --- a/src/Service/TimestreamQuery/src/Result/DescribeEndpointsResponse.php +++ b/src/Service/TimestreamQuery/src/Result/DescribeEndpointsResponse.php @@ -10,6 +10,8 @@ class DescribeEndpointsResponse extends Result { /** * An `Endpoints` object is returned when a `DescribeEndpoints` request is made. + * + * @var Endpoint[] */ private $endpoints; diff --git a/src/Service/TimestreamQuery/src/Result/PrepareQueryResponse.php b/src/Service/TimestreamQuery/src/Result/PrepareQueryResponse.php index c75b9b799..9485ef092 100644 --- a/src/Service/TimestreamQuery/src/Result/PrepareQueryResponse.php +++ b/src/Service/TimestreamQuery/src/Result/PrepareQueryResponse.php @@ -13,16 +13,22 @@ class PrepareQueryResponse extends Result { /** * The query string that you want prepare. + * + * @var string */ private $queryString; /** * A list of SELECT clause columns of the submitted query string. + * + * @var SelectColumn[] */ private $columns; /** * A list of parameters used in the submitted query string. + * + * @var ParameterMapping[] */ private $parameters; diff --git a/src/Service/TimestreamQuery/src/Result/QueryResponse.php b/src/Service/TimestreamQuery/src/Result/QueryResponse.php index 6e16b12af..7859e23ad 100644 --- a/src/Service/TimestreamQuery/src/Result/QueryResponse.php +++ b/src/Service/TimestreamQuery/src/Result/QueryResponse.php @@ -21,26 +21,36 @@ class QueryResponse extends Result implements \IteratorAggregate { /** * A unique ID for the given query. + * + * @var string */ private $queryId; /** * A pagination token that can be used again on a `Query` call to get the next set of results. + * + * @var string|null */ private $nextToken; /** * The result set rows returned by the query. + * + * @var Row[] */ private $rows; /** * The column data types of the returned result set. + * + * @var ColumnInfo[] */ private $columnInfo; /** * Information about the status of the query, including progress and bytes scanned. + * + * @var QueryStatus|null */ private $queryStatus; diff --git a/src/Service/TimestreamQuery/src/ValueObject/ColumnInfo.php b/src/Service/TimestreamQuery/src/ValueObject/ColumnInfo.php index 0eaf1712c..2b7cae0fa 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/ColumnInfo.php +++ b/src/Service/TimestreamQuery/src/ValueObject/ColumnInfo.php @@ -12,12 +12,16 @@ final class ColumnInfo /** * The name of the result set column. The name of the result set is available for columns of all data types except for * arrays. + * + * @var string|null */ private $name; /** * The data type of the result set column. The data type can be a scalar or complex. Scalar data types are integers, * strings, doubles, Booleans, and others. Complex data types are types such as arrays, rows, and others. + * + * @var Type */ private $type; diff --git a/src/Service/TimestreamQuery/src/ValueObject/Datum.php b/src/Service/TimestreamQuery/src/ValueObject/Datum.php index ab3e89dcd..952783e42 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/Datum.php +++ b/src/Service/TimestreamQuery/src/ValueObject/Datum.php @@ -9,26 +9,36 @@ final class Datum { /** * Indicates if the data point is a scalar value such as integer, string, double, or Boolean. + * + * @var string|null */ private $scalarValue; /** * Indicates if the data point is a timeseries data type. + * + * @var TimeSeriesDataPoint[]|null */ private $timeSeriesValue; /** * Indicates if the data point is an array. + * + * @var Datum[]|null */ private $arrayValue; /** * Indicates if the data point is a row. + * + * @var Row|null */ private $rowValue; /** * Indicates if the data point is null. + * + * @var bool|null */ private $nullValue; diff --git a/src/Service/TimestreamQuery/src/ValueObject/Endpoint.php b/src/Service/TimestreamQuery/src/ValueObject/Endpoint.php index d7b361df7..6e457b57c 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/Endpoint.php +++ b/src/Service/TimestreamQuery/src/ValueObject/Endpoint.php @@ -12,11 +12,15 @@ final class Endpoint implements EndpointInterface { /** * An endpoint address. + * + * @var string */ private $address; /** * The TTL for the endpoint, in minutes. + * + * @var int */ private $cachePeriodInMinutes; diff --git a/src/Service/TimestreamQuery/src/ValueObject/ParameterMapping.php b/src/Service/TimestreamQuery/src/ValueObject/ParameterMapping.php index 36104916b..f614746e0 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/ParameterMapping.php +++ b/src/Service/TimestreamQuery/src/ValueObject/ParameterMapping.php @@ -11,9 +11,14 @@ final class ParameterMapping { /** * Parameter name. + * + * @var string */ private $name; + /** + * @var Type + */ private $type; /** diff --git a/src/Service/TimestreamQuery/src/ValueObject/QueryStatus.php b/src/Service/TimestreamQuery/src/ValueObject/QueryStatus.php index 47847be09..e32c196a0 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/QueryStatus.php +++ b/src/Service/TimestreamQuery/src/ValueObject/QueryStatus.php @@ -9,12 +9,16 @@ final class QueryStatus { /** * The progress of the query, expressed as a percentage. + * + * @var float|null */ private $progressPercentage; /** * The amount of data scanned by the query in bytes. This is a cumulative sum and represents the total amount of bytes * scanned since the query was started. + * + * @var int|null */ private $cumulativeBytesScanned; @@ -22,6 +26,8 @@ final class QueryStatus * The amount of data scanned by the query in bytes that you will be charged for. This is a cumulative sum and * represents the total amount of data that you will be charged for since the query was started. The charge is applied * only once and is either applied when the query completes running or when the query is cancelled. + * + * @var int|null */ private $cumulativeBytesMetered; diff --git a/src/Service/TimestreamQuery/src/ValueObject/Row.php b/src/Service/TimestreamQuery/src/ValueObject/Row.php index 7bf522c61..5b4efb2ee 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/Row.php +++ b/src/Service/TimestreamQuery/src/ValueObject/Row.php @@ -11,6 +11,8 @@ final class Row { /** * List of data points in a single row of the result set. + * + * @var Datum[] */ private $data; diff --git a/src/Service/TimestreamQuery/src/ValueObject/SelectColumn.php b/src/Service/TimestreamQuery/src/ValueObject/SelectColumn.php index 829b8a006..40382ccf6 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/SelectColumn.php +++ b/src/Service/TimestreamQuery/src/ValueObject/SelectColumn.php @@ -9,23 +9,34 @@ final class SelectColumn { /** * Name of the column. + * + * @var string|null */ private $name; + /** + * @var Type|null + */ private $type; /** * Database that has this column. + * + * @var string|null */ private $databaseName; /** * Table within the database that has this column. + * + * @var string|null */ private $tableName; /** * True, if the column name was aliased by the query. False otherwise. + * + * @var bool|null */ private $aliased; diff --git a/src/Service/TimestreamQuery/src/ValueObject/TimeSeriesDataPoint.php b/src/Service/TimestreamQuery/src/ValueObject/TimeSeriesDataPoint.php index 291120088..24739cc07 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/TimeSeriesDataPoint.php +++ b/src/Service/TimestreamQuery/src/ValueObject/TimeSeriesDataPoint.php @@ -13,11 +13,15 @@ final class TimeSeriesDataPoint { /** * The timestamp when the measure value was collected. + * + * @var string */ private $time; /** * The measure value for the data point. + * + * @var Datum */ private $value; diff --git a/src/Service/TimestreamQuery/src/ValueObject/Type.php b/src/Service/TimestreamQuery/src/ValueObject/Type.php index e2e5abff0..283c65401 100644 --- a/src/Service/TimestreamQuery/src/ValueObject/Type.php +++ b/src/Service/TimestreamQuery/src/ValueObject/Type.php @@ -13,21 +13,29 @@ final class Type { /** * Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. + * + * @var ScalarType::*|null */ private $scalarType; /** * Indicates if the column is an array. + * + * @var ColumnInfo|null */ private $arrayColumnInfo; /** * Indicates if the column is a timeseries data type. + * + * @var ColumnInfo|null */ private $timeSeriesMeasureValueColumnInfo; /** * Indicates if the column is a row. + * + * @var ColumnInfo[]|null */ private $rowColumnInfo; diff --git a/src/Service/TimestreamWrite/src/Exception/RejectedRecordsException.php b/src/Service/TimestreamWrite/src/Exception/RejectedRecordsException.php index 96a5e48da..77cb8d5b6 100644 --- a/src/Service/TimestreamWrite/src/Exception/RejectedRecordsException.php +++ b/src/Service/TimestreamWrite/src/Exception/RejectedRecordsException.php @@ -28,6 +28,9 @@ */ final class RejectedRecordsException extends ClientException { + /** + * @var RejectedRecord[] + */ private $rejectedRecords; /** diff --git a/src/Service/TimestreamWrite/src/Result/DescribeEndpointsResponse.php b/src/Service/TimestreamWrite/src/Result/DescribeEndpointsResponse.php index 89609849a..df238d80d 100644 --- a/src/Service/TimestreamWrite/src/Result/DescribeEndpointsResponse.php +++ b/src/Service/TimestreamWrite/src/Result/DescribeEndpointsResponse.php @@ -10,6 +10,8 @@ class DescribeEndpointsResponse extends Result { /** * An `Endpoints` object is returned when a `DescribeEndpoints` request is made. + * + * @var Endpoint[] */ private $endpoints; diff --git a/src/Service/TimestreamWrite/src/Result/WriteRecordsResponse.php b/src/Service/TimestreamWrite/src/Result/WriteRecordsResponse.php index fa2599646..210b91e27 100644 --- a/src/Service/TimestreamWrite/src/Result/WriteRecordsResponse.php +++ b/src/Service/TimestreamWrite/src/Result/WriteRecordsResponse.php @@ -10,6 +10,8 @@ class WriteRecordsResponse extends Result { /** * Information on the records ingested by this request. + * + * @var RecordsIngested|null */ private $recordsIngested; diff --git a/src/Service/TimestreamWrite/src/ValueObject/Dimension.php b/src/Service/TimestreamWrite/src/ValueObject/Dimension.php index 69cd0515a..887252fb1 100644 --- a/src/Service/TimestreamWrite/src/ValueObject/Dimension.php +++ b/src/Service/TimestreamWrite/src/ValueObject/Dimension.php @@ -18,16 +18,22 @@ final class Dimension * For constraints on dimension names, see Naming Constraints [^1]. * * [^1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming + * + * @var string */ private $name; /** * The value of the dimension. + * + * @var string */ private $value; /** * The data type of the dimension for the time-series data point. + * + * @var DimensionValueType::*|null */ private $dimensionValueType; diff --git a/src/Service/TimestreamWrite/src/ValueObject/Endpoint.php b/src/Service/TimestreamWrite/src/ValueObject/Endpoint.php index 1ffecfc34..3a2769286 100644 --- a/src/Service/TimestreamWrite/src/ValueObject/Endpoint.php +++ b/src/Service/TimestreamWrite/src/ValueObject/Endpoint.php @@ -12,11 +12,15 @@ final class Endpoint implements EndpointInterface { /** * An endpoint address. + * + * @var string */ private $address; /** * The TTL for the endpoint, in minutes. + * + * @var int */ private $cachePeriodInMinutes; diff --git a/src/Service/TimestreamWrite/src/ValueObject/MeasureValue.php b/src/Service/TimestreamWrite/src/ValueObject/MeasureValue.php index 6fc8c0041..5d9c9e036 100644 --- a/src/Service/TimestreamWrite/src/ValueObject/MeasureValue.php +++ b/src/Service/TimestreamWrite/src/ValueObject/MeasureValue.php @@ -20,6 +20,8 @@ final class MeasureValue * For constraints on MeasureValue names, see Naming Constraints [^1] in the Amazon Timestream Developer Guide. * * [^1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming + * + * @var string */ private $name; @@ -27,11 +29,15 @@ final class MeasureValue * The value for the MeasureValue. For information, see Data types [^1]. * * [^1]: https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types + * + * @var string */ private $value; /** * Contains the data type of the MeasureValue for the time-series data point. + * + * @var MeasureValueType::* */ private $type; diff --git a/src/Service/TimestreamWrite/src/ValueObject/Record.php b/src/Service/TimestreamWrite/src/ValueObject/Record.php index ff07faae9..3411d8c7f 100644 --- a/src/Service/TimestreamWrite/src/ValueObject/Record.php +++ b/src/Service/TimestreamWrite/src/ValueObject/Record.php @@ -23,17 +23,23 @@ final class Record { /** * Contains the list of dimensions for time-series data points. + * + * @var Dimension[]|null */ private $dimensions; /** * Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the * RPM of a wind turbine are measures. + * + * @var string|null */ private $measureName; /** * Contains the measure value for the time-series data point. + * + * @var string|null */ private $measureValue; @@ -42,6 +48,8 @@ final class Record * information, see Data types [^1]. * * [^1]: https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types + * + * @var MeasureValueType::*|null */ private $measureValueType; @@ -49,12 +57,16 @@ final class Record * Contains the time at which the measure value for the data point was collected. The time value plus the unit provides * the time elapsed since the epoch. For example, if the time value is `12345` and the unit is `ms`, then `12345 ms` * have elapsed since the epoch. + * + * @var string|null */ private $time; /** * The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds, or * other supported values. Default is `MILLISECONDS`. + * + * @var TimeUnit::*|null */ private $timeUnit; @@ -64,6 +76,8 @@ final class Record * updated. Default value is `1`. * * > `Version` must be `1` or greater, or you will receive a `ValidationException` error. + * + * @var int|null */ private $version; @@ -71,6 +85,8 @@ final class Record * Contains the list of MeasureValue for time-series data points. * * This is only allowed for type `MULTI`. For scalar values, use `MeasureValue` attribute of the record directly. + * + * @var MeasureValue[]|null */ private $measureValues; diff --git a/src/Service/TimestreamWrite/src/ValueObject/RecordsIngested.php b/src/Service/TimestreamWrite/src/ValueObject/RecordsIngested.php index b0b789ff7..4ed99e117 100644 --- a/src/Service/TimestreamWrite/src/ValueObject/RecordsIngested.php +++ b/src/Service/TimestreamWrite/src/ValueObject/RecordsIngested.php @@ -9,16 +9,22 @@ final class RecordsIngested { /** * Total count of successfully ingested records. + * + * @var int|null */ private $total; /** * Count of records ingested into the memory store. + * + * @var int|null */ private $memoryStore; /** * Count of records ingested into the magnetic store. + * + * @var int|null */ private $magneticStore; diff --git a/src/Service/TimestreamWrite/src/ValueObject/RejectedRecord.php b/src/Service/TimestreamWrite/src/ValueObject/RejectedRecord.php index c6bdc1255..30f9d9d97 100644 --- a/src/Service/TimestreamWrite/src/ValueObject/RejectedRecord.php +++ b/src/Service/TimestreamWrite/src/ValueObject/RejectedRecord.php @@ -10,6 +10,8 @@ final class RejectedRecord { /** * The index of the record in the input request for WriteRecords. Indexes begin with 0. + * + * @var int|null */ private $recordIndex; @@ -40,12 +42,16 @@ final class RejectedRecord * [^1]: https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration * [^2]: https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html * [^3]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html + * + * @var string|null */ private $reason; /** * The existing version of the record. This value is populated in scenarios where an identical record exists with a * higher version than the version in the write request. + * + * @var int|null */ private $existingVersion; diff --git a/src/Service/Translate/src/Exception/DetectedLanguageLowConfidenceException.php b/src/Service/Translate/src/Exception/DetectedLanguageLowConfidenceException.php index 896be4823..d0b2fec9c 100644 --- a/src/Service/Translate/src/Exception/DetectedLanguageLowConfidenceException.php +++ b/src/Service/Translate/src/Exception/DetectedLanguageLowConfidenceException.php @@ -16,6 +16,8 @@ final class DetectedLanguageLowConfidenceException extends ClientException { /** * The language code of the auto-detected language from Amazon Comprehend. + * + * @var string|null */ private $detectedLanguageCode; diff --git a/src/Service/Translate/src/Exception/UnsupportedLanguagePairException.php b/src/Service/Translate/src/Exception/UnsupportedLanguagePairException.php index 97fac052f..9391a1d05 100644 --- a/src/Service/Translate/src/Exception/UnsupportedLanguagePairException.php +++ b/src/Service/Translate/src/Exception/UnsupportedLanguagePairException.php @@ -15,11 +15,15 @@ final class UnsupportedLanguagePairException extends ClientException { /** * The language code for the language of the input text. + * + * @var string|null */ private $sourceLanguageCode; /** * The language code for the language of the translated text. + * + * @var string|null */ private $targetLanguageCode; diff --git a/src/Service/Translate/src/Result/TranslateTextResponse.php b/src/Service/Translate/src/Result/TranslateTextResponse.php index d1344413f..24c4b52ae 100644 --- a/src/Service/Translate/src/Result/TranslateTextResponse.php +++ b/src/Service/Translate/src/Result/TranslateTextResponse.php @@ -12,26 +12,36 @@ class TranslateTextResponse extends Result { /** * The translated text. + * + * @var string */ private $translatedText; /** * The language code for the language of the source text. + * + * @var string */ private $sourceLanguageCode; /** * The language code for the language of the target text. + * + * @var string */ private $targetLanguageCode; /** * The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response. + * + * @var AppliedTerminology[] */ private $appliedTerminologies; /** * Optional settings that modify the translation output. + * + * @var TranslationSettings|null */ private $appliedSettings; diff --git a/src/Service/Translate/src/ValueObject/AppliedTerminology.php b/src/Service/Translate/src/ValueObject/AppliedTerminology.php index bf3c5e178..c8f2becd3 100644 --- a/src/Service/Translate/src/ValueObject/AppliedTerminology.php +++ b/src/Service/Translate/src/ValueObject/AppliedTerminology.php @@ -11,6 +11,8 @@ final class AppliedTerminology { /** * The name of the custom terminology applied to the input text by Amazon Translate for the translated text response. + * + * @var string|null */ private $name; @@ -18,6 +20,8 @@ final class AppliedTerminology * The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text * response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the * source text. + * + * @var Term[]|null */ private $terms; diff --git a/src/Service/Translate/src/ValueObject/Term.php b/src/Service/Translate/src/ValueObject/Term.php index 328cdf550..7df4a92f3 100644 --- a/src/Service/Translate/src/ValueObject/Term.php +++ b/src/Service/Translate/src/ValueObject/Term.php @@ -9,11 +9,15 @@ final class Term { /** * The source text of the term being translated by the custom terminology. + * + * @var string|null */ private $sourceText; /** * The target text of the term being translated by the custom terminology. + * + * @var string|null */ private $targetText; diff --git a/src/Service/Translate/src/ValueObject/TranslationSettings.php b/src/Service/Translate/src/ValueObject/TranslationSettings.php index 91e1d0328..1227c6f7d 100644 --- a/src/Service/Translate/src/ValueObject/TranslationSettings.php +++ b/src/Service/Translate/src/ValueObject/TranslationSettings.php @@ -26,6 +26,8 @@ final class TranslationSettings * * [^1]: https://en.wikipedia.org/wiki/Register_(sociolinguistics) * [^2]: https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-formality.html#customizing-translations-formality-languages + * + * @var Formality::*|null */ private $formality; @@ -44,6 +46,8 @@ final class TranslationSettings * language. * * [^1]: https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-profanity.html#customizing-translations-profanity-languages + * + * @var Profanity::*|null */ private $profanity; diff --git a/src/Service/XRay/src/Result/PutTraceSegmentsResult.php b/src/Service/XRay/src/Result/PutTraceSegmentsResult.php index 756a4c8e8..a8b5139a3 100644 --- a/src/Service/XRay/src/Result/PutTraceSegmentsResult.php +++ b/src/Service/XRay/src/Result/PutTraceSegmentsResult.php @@ -10,6 +10,8 @@ class PutTraceSegmentsResult extends Result { /** * Segments that failed processing. + * + * @var UnprocessedTraceSegment[] */ private $unprocessedTraceSegments; diff --git a/src/Service/XRay/src/ValueObject/UnprocessedTraceSegment.php b/src/Service/XRay/src/ValueObject/UnprocessedTraceSegment.php index ac8d42be7..66e7736a3 100644 --- a/src/Service/XRay/src/ValueObject/UnprocessedTraceSegment.php +++ b/src/Service/XRay/src/ValueObject/UnprocessedTraceSegment.php @@ -9,16 +9,22 @@ final class UnprocessedTraceSegment { /** * The segment's ID. + * + * @var string|null */ private $id; /** * The error that caused processing to fail. + * + * @var string|null */ private $errorCode; /** * The error message. + * + * @var string|null */ private $message;