Managed Streaming for Kafka

2026/11/19 - Managed Streaming for Kafka - 9 new 7 updated api methods

Changes  Amazon MSK now supports in-place migration of provisioned clusters from Standard to Express brokers. This release adds APIs to assess a cluster before migration and to reassign topics, and returns broker type upgrade details in cluster operations.

ListTopicReassignments (new) Link ¶

Lists topic reassignment operations for a cluster.

See also: AWS API Documentation

Request Syntax

client.list_topic_reassignments(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string',
    StatusFilter='string'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

type MaxResults:

integer

param MaxResults:

Maximum number of reassignment operations to return. Default 50, maximum 100.

type NextToken:

string

param NextToken:

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

type StatusFilter:

string

param StatusFilter:

Optional filter. Only return reassignments matching these statuses.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Reassignments': [
        {
            'CompletedTopics': 123,
            'CreationTime': datetime(2015, 1, 1),
            'Status': 'PENDING'|'IN_PROGRESS'|'STOPPING'|'COMPLETE'|'FAILED'|'STOPPED',
            'TargetInstanceType': 'string',
            'TopicReassignmentOperationArn': 'string',
            'TotalTopics': 123
        },
    ]
}

Response Structure

  • (dict) --

    200 response

    • NextToken (string) --

      If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

    • Reassignments (list) --

      A list of topic reassignment operation summaries.

      • (dict) --

        Summary information about a topic reassignment operation.

        • CompletedTopics (integer) --

          Number of topics fully migrated.

        • CreationTime (datetime) --

          When the operation was created.

        • Status (string) --

          The current status of the reassignment operation.

        • TargetInstanceType (string) --

          The target broker instance type for this reassignment.

        • TopicReassignmentOperationArn (string) --

          The Amazon Resource Name (ARN) of the topic reassignment operation.

        • TotalTopics (integer) --

          Total number of topics matching the selector.

DescribeTopicReassignment (new) Link ¶

Returns the status and progress of a topic reassignment operation.

See also: AWS API Documentation

Request Syntax

client.describe_topic_reassignment(
    ClusterArn='string',
    TopicReassignmentOperationArn='string'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

type TopicReassignmentOperationArn:

string

param TopicReassignmentOperationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the topic reassignment operation.

rtype:

dict

returns:

Response Syntax

{
    'ClusterArn': 'string',
    'CompletedTopics': 123,
    'CreationTime': datetime(2015, 1, 1),
    'ErrorInfo': {
        'ErrorCode': 'string',
        'ErrorString': 'string'
    },
    'LastUpdateTime': datetime(2015, 1, 1),
    'MigratedPartitions': 123,
    'Status': 'PENDING'|'IN_PROGRESS'|'STOPPING'|'COMPLETE'|'FAILED'|'STOPPED',
    'TargetInstanceType': 'string',
    'TopicReassignmentOperationArn': 'string',
    'TopicsToExclude': [
        'string',
    ],
    'TopicsToInclude': [
        'string',
    ],
    'TotalPartitions': 123,
    'TotalTopics': 123
}

Response Structure

  • (dict) --

    200 response

    • ClusterArn (string) --

      The Amazon Resource Name (ARN) of the cluster.

    • CompletedTopics (integer) --

      Number of topics fully migrated to the target broker type.

    • CreationTime (datetime) --

      When the operation was created.

    • ErrorInfo (dict) --

      Error details. Present only when status is FAILED.

      • ErrorCode (string) --

        A number describing the error programmatically.

      • ErrorString (string) --

        An optional field to provide more details about the error.

    • LastUpdateTime (datetime) --

      Last time the status or progress counters were updated.

    • MigratedPartitions (integer) --

      Number of partitions confirmed on the target broker type.

    • Status (string) --

      The current status of the reassignment operation.

    • TargetInstanceType (string) --

      The target broker instance type for this reassignment.

    • TopicReassignmentOperationArn (string) --

      The Amazon Resource Name (ARN) of the topic reassignment operation.

    • TopicsToExclude (list) --

      The original exclude patterns provided in the request.

      • (string) --

    • TopicsToInclude (list) --

      The original include patterns provided in the request.

      • (string) --

    • TotalPartitions (integer) --

      Total number of partitions across all matched topics.

    • TotalTopics (integer) --

      Total number of topics matching the selector at resolution time.

ListAssessments (new) Link ¶

Returns a list of assessments for the specified cluster. Optionally filterable by assessment type.

See also: AWS API Documentation

Request Syntax

client.list_assessments(
    AssessmentType='string',
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)
type AssessmentType:

string

param AssessmentType:

Optional filter. The type of assessment to filter by.

type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster to list assessments for.

type MaxResults:

integer

param MaxResults:

Maximum number of assessments to return. Default 25, maximum 100.

type NextToken:

string

param NextToken:

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

rtype:

dict

returns:

Response Syntax

{
    'Assessments': [
        {
            'AssessmentArn': 'string',
            'AssessmentType': 'UPDATE_BROKER_TYPE',
            'ClusterArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Status': 'IN_PROGRESS'|'COMPLETE'|'FAILED'|'DELETING',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    200 response

    • Assessments (list) --

      A list of assessment summaries.

      • (dict) --

        Summary information about an assessment, returned by ListAssessments.

        • AssessmentArn (string) --

          The Amazon Resource Name (ARN) of the assessment.

        • AssessmentType (string) --

          The type of assessment.

        • ClusterArn (string) --

          The Amazon Resource Name (ARN) of the cluster that was assessed.

        • CreationTime (datetime) --

          The time when the assessment was created.

        • Status (string) --

          The current status of the assessment.

        • Tags (dict) --

          The tags attached to the assessment.

          • (string) --

            • (string) --

    • NextToken (string) --

      If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

CreateAssessment (new) Link ¶

Creates a new assessment for the specified cluster. Kicks off an asynchronous scan.

See also: AWS API Documentation

Request Syntax

client.create_assessment(
    AssessmentParameters={
        'TargetInstanceType': 'string'
    },
    AssessmentType='UPDATE_BROKER_TYPE',
    ClusterArn='string',
    Tags={
        'string': 'string'
    }
)
type AssessmentParameters:

dict

param AssessmentParameters:

Optional type-specific parameters for the assessment.

  • TargetInstanceType (string) --

    The target instance type to assess against (for example, express.m7g.large). Optional: when omitted, the assessment reports a recommended instance type as a CAPACITY finding. Supply it to assess readiness for a specific instance type.

type AssessmentType:

string

param AssessmentType:

[REQUIRED]

The type of assessment to perform.

type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster to assess.

type Tags:

dict

param Tags:

The tags to attach to the assessment.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'AssessmentArn': 'string',
    'AssessmentType': 'UPDATE_BROKER_TYPE',
    'ClusterArn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'Status': 'IN_PROGRESS'|'COMPLETE'|'FAILED'|'DELETING'
}

Response Structure

  • (dict) --

    200 response

    • AssessmentArn (string) --

      The Amazon Resource Name (ARN) of the assessment.

    • AssessmentType (string) --

      The type of assessment.

    • ClusterArn (string) --

      The Amazon Resource Name (ARN) of the cluster being assessed.

    • CreationTime (datetime) --

      The time when the assessment was created.

    • Status (string) --

      The current status of the assessment.

DescribeAssessment (new) Link ¶

Returns the status and summary of an assessment.

See also: AWS API Documentation

Request Syntax

client.describe_assessment(
    AssessmentArn='string',
    ClusterArn='string'
)
type AssessmentArn:

string

param AssessmentArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the assessment.

type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

rtype:

dict

returns:

Response Syntax

{
    'AssessmentArn': 'string',
    'AssessmentParameters': {
        'TargetInstanceType': 'string'
    },
    'AssessmentType': 'UPDATE_BROKER_TYPE',
    'ClusterArn': 'string',
    'CompletionTime': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'Status': 'IN_PROGRESS'|'COMPLETE'|'FAILED'|'DELETING',
    'StatusMessage': 'string',
    'Summary': {
        'ByCategory': {
            'string': 123
        },
        'BySeverity': {
            'string': 123
        },
        'FindingsCapped': True|False,
        'HasBlockingFindings': True|False,
        'TotalFindings': 123
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    200 response

    • AssessmentArn (string) --

      The Amazon Resource Name (ARN) of the assessment.

    • AssessmentParameters (dict) --

      The parameters that were provided when creating the assessment.

      • TargetInstanceType (string) --

        The target instance type to assess against (for example, express.m7g.large). Optional: when omitted, the assessment reports a recommended instance type as a CAPACITY finding. Supply it to assess readiness for a specific instance type.

    • AssessmentType (string) --

      The type of assessment.

    • ClusterArn (string) --

      The Amazon Resource Name (ARN) of the cluster that was assessed.

    • CompletionTime (datetime) --

      The time when the assessment completed. Present only when status is COMPLETE or FAILED.

    • CreationTime (datetime) --

      The time when the assessment was created.

    • Status (string) --

      The current status of the assessment.

    • StatusMessage (string) --

      Additional information about the current status. Present when status is FAILED.

    • Summary (dict) --

      Summary of findings by category and severity. Present only when status is COMPLETE.

      • ByCategory (dict) --

        Count of findings grouped by category.

        • (string) --

          • (integer) --

      • BySeverity (dict) --

        Count of findings grouped by severity.

        • (string) --

          • (integer) --

      • FindingsCapped (boolean) --

        True when the assessment detected more findings than it stores. Resolve the reported findings and re-run the assessment to surface the remaining ones.

      • HasBlockingFindings (boolean) --

        True when the assessment detected at least one ERROR-severity finding. ERROR findings block the migration until resolved.

      • TotalFindings (integer) --

        The total number of findings detected by the assessment, including any findings beyond the stored-findings cap.

    • Tags (dict) --

      The tags attached to the assessment.

      • (string) --

        • (string) --

DeleteAssessment (new) Link ¶

Deletes an assessment and its findings. Frees one slot against the cluster's assessment quota.

See also: AWS API Documentation

Request Syntax

client.delete_assessment(
    AssessmentArn='string',
    ClusterArn='string'
)
type AssessmentArn:

string

param AssessmentArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the assessment to delete.

type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

rtype:

dict

returns:

Response Syntax

{
    'AssessmentArn': 'string',
    'Status': 'IN_PROGRESS'|'COMPLETE'|'FAILED'|'DELETING'
}

Response Structure

  • (dict) --

    200 response

    • AssessmentArn (string) --

      The Amazon Resource Name (ARN) of the assessment being deleted.

    • Status (string) --

      The current status of the assessment. Will be DELETING.

ListAssessmentFindings (new) Link ¶

Returns the findings for a completed assessment. Paginated.

See also: AWS API Documentation

Request Syntax

client.list_assessment_findings(
    AssessmentArn='string',
    Category='string',
    ClusterArn='string',
    MaxResults=123,
    NextToken='string',
    Severity='string'
)
type AssessmentArn:

string

param AssessmentArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the assessment.

type Category:

string

param Category:

Optional filter. Only return findings matching this category.

type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

type MaxResults:

integer

param MaxResults:

Maximum number of findings to return. Default 100, maximum 500.

type NextToken:

string

param NextToken:

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

type Severity:

string

param Severity:

Optional filter. Only return findings matching this severity.

rtype:

dict

returns:

Response Syntax

{
    'Findings': [
        {
            'Category': 'INFRASTRUCTURE'|'BROKER_CONFIGURATION'|'TOPIC_CONFIGURATION'|'CAPACITY'|'HEALTH',
            'FindingId': 'string',
            'Message': 'string',
            'Remediation': {
                'Action': 'string',
                'DocumentationUrl': 'string'
            },
            'Resource': 'string',
            'Severity': 'ERROR'|'WARNING'|'INFO'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    200 response

    • Findings (list) --

      A list of findings from the assessment.

      • (dict) --

        A single finding from an assessment, describing a specific issue or observation.

        • Category (string) --

          The category of this finding.

        • FindingId (string) --

          A deterministic content-based identifier for this finding. Generated from hash(category + resource + check_type). The same resource with the same problem always produces the same findingId across assessment runs.

        • Message (string) --

          Human-readable description of what is wrong, why it matters, and what to do.

        • Remediation (dict) --

          Guidance for resolving this finding. Absent when no specific remediation applies.

          • Action (string) --

            The recommended action to resolve this finding.

          • DocumentationUrl (string) --

            A link to documentation with more detail about this finding and how to resolve it.

        • Resource (string) --

          The specific resource affected (e.g., topic name). Absent for cluster-level findings.

        • Severity (string) --

          The severity of this finding.

    • NextToken (string) --

      If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

StartTopicReassignment (new) Link ¶

Initiates topic partition reassignment between broker types in a mixed-mode cluster.

See also: AWS API Documentation

Request Syntax

client.start_topic_reassignment(
    ClientToken='string',
    ClusterArn='string',
    TargetInstanceType='string',
    TopicsToExclude=[
        'string',
    ],
    TopicsToInclude=[
        'string',
    ]
)
type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token within 24 hours, the API returns the original response without creating a duplicate operation.

type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

type TargetInstanceType:

string

param TargetInstanceType:

[REQUIRED]

Instance type of the target brokers. Must exist in the cluster. Use Express instance type (e.g., express.m7g.large) for Standard-to-Express migration. Use Standard instance type (e.g., kafka.m7g.large) to move topics back to Standard.

type TopicsToExclude:

list

param TopicsToExclude:

Regex patterns for topics to exclude from reassignment. Evaluated after include patterns.

  • (string) --

type TopicsToInclude:

list

param TopicsToInclude:

[REQUIRED]

Regex patterns for topics to reassign. Use ['.*'] for all topics. Max 10 patterns.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'ClusterArn': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'STOPPING'|'COMPLETE'|'FAILED'|'STOPPED',
    'TopicReassignmentOperationArn': 'string'
}

Response Structure

  • (dict) --

    200 response

    • ClusterArn (string) --

      The Amazon Resource Name (ARN) of the cluster.

    • Status (string) --

      The current status of the reassignment operation.

    • TopicReassignmentOperationArn (string) --

      The Amazon Resource Name (ARN) of the topic reassignment operation.

StopTopicReassignment (new) Link ¶

Stops an active topic reassignment operation.

See also: AWS API Documentation

Request Syntax

client.stop_topic_reassignment(
    ClusterArn='string',
    TopicReassignmentOperationArn='string'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.

type TopicReassignmentOperationArn:

string

param TopicReassignmentOperationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the topic reassignment operation to stop.

rtype:

dict

returns:

Response Syntax

{
    'Status': 'PENDING'|'IN_PROGRESS'|'STOPPING'|'COMPLETE'|'FAILED'|'STOPPED',
    'TopicReassignmentOperationArn': 'string'
}

Response Structure

  • (dict) --

    200 response

    • Status (string) --

      The current status of the operation. Will be STOPPING.

    • TopicReassignmentOperationArn (string) --

      The Amazon Resource Name (ARN) of the topic reassignment operation.

DescribeClusterOperation (updated) Link ¶
Changes (response)
{'ClusterOperationInfo': {'BrokerTypeUpgradeInfo': {'TopicReassignmentMode': 'AUTO '
                                                                             '| '
                                                                             'MANUAL',
                                                    'TopicReassignmentOperationArn': 'string'}}}

Returns a description of the cluster operation specified by the ARN.

See also: AWS API Documentation

Request Syntax

client.describe_cluster_operation(
    ClusterOperationArn='string'
)
type ClusterOperationArn:

string

param ClusterOperationArn:

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.

rtype:

dict

returns:

Response Syntax

{
    'ClusterOperationInfo': {
        'BrokerTypeUpgradeInfo': {
            'TopicReassignmentMode': 'AUTO'|'MANUAL',
            'TopicReassignmentOperationArn': 'string'
        },
        'ClientRequestId': 'string',
        'ClusterArn': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'ErrorInfo': {
            'ErrorCode': 'string',
            'ErrorString': 'string'
        },
        'OperationArn': 'string',
        'OperationState': 'string',
        'OperationSteps': [
            {
                'StepInfo': {
                    'StepStatus': 'string'
                },
                'StepName': 'string'
            },
        ],
        'OperationType': 'string',
        'SourceClusterInfo': {
            'BrokerEBSVolumeInfo': [
                {
                    'KafkaBrokerNodeId': 'string',
                    'ProvisionedThroughput': {
                        'Enabled': True|False,
                        'VolumeThroughput': 123
                    },
                    'VolumeSizeGB': 123
                },
            ],
            'ConfigurationInfo': {
                'Arn': 'string',
                'Revision': 123
            },
            'NumberOfBrokerNodes': 123,
            'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
            'OpenMonitoring': {
                'Prometheus': {
                    'JmxExporter': {
                        'EnabledInBroker': True|False
                    },
                    'NodeExporter': {
                        'EnabledInBroker': True|False
                    }
                }
            },
            'ZookeeperAccess': {
                'Enabled': True|False
            },
            'KafkaVersion': 'string',
            'LoggingInfo': {
                'AuthorizerLogs': {
                    'CloudWatchLogs': {
                        'Enabled': True|False,
                        'LogGroup': 'string'
                    },
                    'Firehose': {
                        'DeliveryStream': 'string',
                        'Enabled': True|False
                    },
                    'S3': {
                        'Bucket': 'string',
                        'Enabled': True|False,
                        'Prefix': 'string'
                    }
                },
                'BrokerLogs': {
                    'CloudWatchLogs': {
                        'Enabled': True|False,
                        'LogGroup': 'string'
                    },
                    'Firehose': {
                        'DeliveryStream': 'string',
                        'Enabled': True|False
                    },
                    'S3': {
                        'Bucket': 'string',
                        'Enabled': True|False,
                        'Prefix': 'string'
                    }
                }
            },
            'InstanceType': 'string',
            'ClientAuthentication': {
                'Sasl': {
                    'Scram': {
                        'Enabled': True|False
                    },
                    'Iam': {
                        'Enabled': True|False
                    }
                },
                'Tls': {
                    'CertificateAuthorityArnList': [
                        'string',
                    ],
                    'Enabled': True|False
                },
                'Unauthenticated': {
                    'Enabled': True|False
                }
            },
            'EncryptionInfo': {
                'EncryptionAtRest': {
                    'DataVolumeKMSKeyId': 'string'
                },
                'EncryptionInTransit': {
                    'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
                    'InCluster': True|False
                }
            },
            'ConnectivityInfo': {
                'PublicAccess': {
                    'Type': 'string'
                },
                'VpcConnectivity': {
                    'ClientAuthentication': {
                        'Sasl': {
                            'Scram': {
                                'Enabled': True|False
                            },
                            'Iam': {
                                'Enabled': True|False
                            }
                        },
                        'Tls': {
                            'Enabled': True|False
                        }
                    }
                },
                'NetworkType': 'IPV4'|'DUAL'
            },
            'StorageMode': 'LOCAL'|'TIERED',
            'BrokerCountUpdateInfo': {
                'CreatedBrokerIds': [
                    123.0,
                ],
                'DeletedBrokerIds': [
                    123.0,
                ]
            },
            'Rebalancing': {
                'Status': 'PAUSED'|'ACTIVE'
            }
        },
        'TargetClusterInfo': {
            'BrokerEBSVolumeInfo': [
                {
                    'KafkaBrokerNodeId': 'string',
                    'ProvisionedThroughput': {
                        'Enabled': True|False,
                        'VolumeThroughput': 123
                    },
                    'VolumeSizeGB': 123
                },
            ],
            'ConfigurationInfo': {
                'Arn': 'string',
                'Revision': 123
            },
            'NumberOfBrokerNodes': 123,
            'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
            'OpenMonitoring': {
                'Prometheus': {
                    'JmxExporter': {
                        'EnabledInBroker': True|False
                    },
                    'NodeExporter': {
                        'EnabledInBroker': True|False
                    }
                }
            },
            'ZookeeperAccess': {
                'Enabled': True|False
            },
            'KafkaVersion': 'string',
            'LoggingInfo': {
                'AuthorizerLogs': {
                    'CloudWatchLogs': {
                        'Enabled': True|False,
                        'LogGroup': 'string'
                    },
                    'Firehose': {
                        'DeliveryStream': 'string',
                        'Enabled': True|False
                    },
                    'S3': {
                        'Bucket': 'string',
                        'Enabled': True|False,
                        'Prefix': 'string'
                    }
                },
                'BrokerLogs': {
                    'CloudWatchLogs': {
                        'Enabled': True|False,
                        'LogGroup': 'string'
                    },
                    'Firehose': {
                        'DeliveryStream': 'string',
                        'Enabled': True|False
                    },
                    'S3': {
                        'Bucket': 'string',
                        'Enabled': True|False,
                        'Prefix': 'string'
                    }
                }
            },
            'InstanceType': 'string',
            'ClientAuthentication': {
                'Sasl': {
                    'Scram': {
                        'Enabled': True|False
                    },
                    'Iam': {
                        'Enabled': True|False
                    }
                },
                'Tls': {
                    'CertificateAuthorityArnList': [
                        'string',
                    ],
                    'Enabled': True|False
                },
                'Unauthenticated': {
                    'Enabled': True|False
                }
            },
            'EncryptionInfo': {
                'EncryptionAtRest': {
                    'DataVolumeKMSKeyId': 'string'
                },
                'EncryptionInTransit': {
                    'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
                    'InCluster': True|False
                }
            },
            'ConnectivityInfo': {
                'PublicAccess': {
                    'Type': 'string'
                },
                'VpcConnectivity': {
                    'ClientAuthentication': {
                        'Sasl': {
                            'Scram': {
                                'Enabled': True|False
                            },
                            'Iam': {
                                'Enabled': True|False
                            }
                        },
                        'Tls': {
                            'Enabled': True|False
                        }
                    }
                },
                'NetworkType': 'IPV4'|'DUAL'
            },
            'StorageMode': 'LOCAL'|'TIERED',
            'BrokerCountUpdateInfo': {
                'CreatedBrokerIds': [
                    123.0,
                ],
                'DeletedBrokerIds': [
                    123.0,
                ]
            },
            'Rebalancing': {
                'Status': 'PAUSED'|'ACTIVE'
            }
        },
        'VpcConnectionInfo': {
            'VpcConnectionArn': 'string',
            'Owner': 'string',
            'UserIdentity': {
                'Type': 'AWSACCOUNT'|'AWSSERVICE',
                'PrincipalId': 'string'
            },
            'CreationTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    200 response

    • ClusterOperationInfo (dict) --

      Cluster operation information

      • BrokerTypeUpgradeInfo (dict) --

        Topic reassignment details of the UpdateBrokerType operation that started an upgrade from Standard brokers to Express brokers.

        • TopicReassignmentMode (string) --

          How topics are reassigned to the Express brokers.

        • TopicReassignmentOperationArn (string) --

          The Amazon Resource Name (ARN) of the topic reassignment operation that Amazon MSK started for this upgrade. Present once that reassignment has started. Under MANUAL you start reassignments yourself, so Amazon MSK starts none.

      • ClientRequestId (string) --

        The ID of the API request that triggered this operation.

      • ClusterArn (string) --

        ARN of the cluster.

      • CreationTime (datetime) --

        The time that the operation was created.

      • EndTime (datetime) --

        The time at which the operation finished.

      • ErrorInfo (dict) --

        Describes the error if the operation fails.

        • ErrorCode (string) --

          A number describing the error programmatically.

        • ErrorString (string) --

          An optional field to provide more details about the error.

      • OperationArn (string) --

        ARN of the cluster operation.

      • OperationState (string) --

        State of the cluster operation.

      • OperationSteps (list) --

        Steps completed during the operation.

        • (dict) --

          Step taken during a cluster operation.

          • StepInfo (dict) --

            Information about the step and its status.

            • StepStatus (string) --

              The steps current status.

          • StepName (string) --

            The name of the step.

      • OperationType (string) --

        Type of the cluster operation.

      • SourceClusterInfo (dict) --

        Information about cluster attributes before a cluster is updated.

        • BrokerEBSVolumeInfo (list) --

          Specifies the size of the EBS volume and the ID of the associated broker.

          • (dict) --

            Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

            • KafkaBrokerNodeId (string) --

              The ID of the broker to update.

            • ProvisionedThroughput (dict) --

              EBS volume provisioned throughput information.

              • Enabled (boolean) --

                Provisioned throughput is enabled or not.

              • VolumeThroughput (integer) --

                Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

            • VolumeSizeGB (integer) --

              Size of the EBS volume to update.

        • ConfigurationInfo (dict) --

          Information about the changes in the configuration of the brokers.

          • Arn (string) --

            ARN of the configuration to use.

          • Revision (integer) --

            The revision of the configuration to use.

        • NumberOfBrokerNodes (integer) --

          The number of broker nodes in the cluster.

        • EnhancedMonitoring (string) --

          Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

        • OpenMonitoring (dict) --

          The settings for open monitoring.

          • Prometheus (dict) --

            Prometheus settings.

            • JmxExporter (dict) --

              Indicates whether you want to turn on or turn off the JMX Exporter.

              • EnabledInBroker (boolean) --

                Indicates whether you want to turn on or turn off the JMX Exporter.

            • NodeExporter (dict) --

              Indicates whether you want to turn on or turn off the Node Exporter.

              • EnabledInBroker (boolean) --

                Indicates whether you want to turn on or turn off the Node Exporter.

        • ZookeeperAccess (dict) --

          Access control settings for zookeeper

          • Enabled (boolean) --

            Zookeeper Access was on or off for the cluster

        • KafkaVersion (string) --

          The Apache Kafka version.

        • LoggingInfo (dict) --

          You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

          • AuthorizerLogs (dict) --

            You can configure your MSK cluster to send authorizer logs to different destination types.

            • CloudWatchLogs (dict) --

              Details of the CloudWatch Logs destination for authorizer logs.

              • Enabled (boolean) --

              • LogGroup (string) --

            • Firehose (dict) --

              Details of the Kinesis Data Firehose delivery stream that is the destination for authorizer logs.

              • DeliveryStream (string) --

              • Enabled (boolean) --

            • S3 (dict) --

              Details of the Amazon S3 destination for authorizer logs.

              • Bucket (string) --

              • Enabled (boolean) --

              • Prefix (string) --

          • BrokerLogs (dict) --

            • CloudWatchLogs (dict) --

              • Enabled (boolean) --

              • LogGroup (string) --

            • Firehose (dict) --

              • DeliveryStream (string) --

              • Enabled (boolean) --

            • S3 (dict) --

              • Bucket (string) --

              • Enabled (boolean) --

              • Prefix (string) --

        • InstanceType (string) --

          Information about the Amazon MSK broker type.

        • ClientAuthentication (dict) --

          Includes all client authentication information.

          • Sasl (dict) --

            Details for ClientAuthentication using SASL.

            • Scram (dict) --

              Details for SASL/SCRAM client authentication.

              • Enabled (boolean) --

                SASL/SCRAM authentication is enabled or not.

            • Iam (dict) --

              Indicates whether IAM access control is enabled.

              • Enabled (boolean) --

                Indicates whether IAM access control is enabled.

          • Tls (dict) --

            Details for ClientAuthentication using TLS.

            • CertificateAuthorityArnList (list) --

              List of ACM Certificate Authority ARNs.

              • (string) --

            • Enabled (boolean) --

              Specifies whether you want to turn on or turn off TLS authentication.

          • Unauthenticated (dict) --

            Contains information about unauthenticated traffic to the cluster.

            • Enabled (boolean) --

              Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

        • EncryptionInfo (dict) --

          Includes all encryption-related information.

          • EncryptionAtRest (dict) --

            The data-volume encryption details.

            • DataVolumeKMSKeyId (string) --

              The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

          • EncryptionInTransit (dict) --

            The details for encryption in transit.

            • ClientBroker (string) --

              Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

              TLS means that client-broker communication is enabled with TLS only.

              TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

              PLAINTEXT means that client-broker communication is enabled in plaintext only.

              The default value is TLS_PLAINTEXT.

            • InCluster (boolean) --

              When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

              The default value is true.

        • ConnectivityInfo (dict) --

          Information about the broker access configuration.

          • PublicAccess (dict) --

            Public access control for brokers.

            • Type (string) --

              The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

          • VpcConnectivity (dict) --

            VPC connectivity access control for brokers.

            • ClientAuthentication (dict) --

              Includes all client authentication information for VPC connectivity.

              • Sasl (dict) --

                SASL authentication type details for VPC connectivity.

                • Scram (dict) --

                  Details for SASL/SCRAM client authentication for VPC connectivity.

                  • Enabled (boolean) --

                    SASL/SCRAM authentication is on or off for VPC connectivity.

                • Iam (dict) --

                  Details for SASL/IAM client authentication for VPC connectivity.

                  • Enabled (boolean) --

                    SASL/IAM authentication is on or off for VPC connectivity.

              • Tls (dict) --

                TLS authentication type details for VPC connectivity.

                • Enabled (boolean) --

                  TLS authentication is on or off for VPC connectivity.

          • NetworkType (string) --

            The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

            By default, a cluster uses the IPv4 network type.

        • StorageMode (string) --

          This controls storage mode for supported storage tiers.

        • BrokerCountUpdateInfo (dict) --

          Describes brokers being changed during a broker count update.

          • CreatedBrokerIds (list) --

            Kafka Broker IDs of brokers being created.

            • (float) --

          • DeletedBrokerIds (list) --

            Kafka Broker IDs of brokers being deleted.

            • (float) --

        • Rebalancing (dict) --

          Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

          • Status (string) --

            Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

      • TargetClusterInfo (dict) --

        Information about cluster attributes after a cluster is updated.

        • BrokerEBSVolumeInfo (list) --

          Specifies the size of the EBS volume and the ID of the associated broker.

          • (dict) --

            Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

            • KafkaBrokerNodeId (string) --

              The ID of the broker to update.

            • ProvisionedThroughput (dict) --

              EBS volume provisioned throughput information.

              • Enabled (boolean) --

                Provisioned throughput is enabled or not.

              • VolumeThroughput (integer) --

                Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

            • VolumeSizeGB (integer) --

              Size of the EBS volume to update.

        • ConfigurationInfo (dict) --

          Information about the changes in the configuration of the brokers.

          • Arn (string) --

            ARN of the configuration to use.

          • Revision (integer) --

            The revision of the configuration to use.

        • NumberOfBrokerNodes (integer) --

          The number of broker nodes in the cluster.

        • EnhancedMonitoring (string) --

          Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

        • OpenMonitoring (dict) --

          The settings for open monitoring.

          • Prometheus (dict) --

            Prometheus settings.

            • JmxExporter (dict) --

              Indicates whether you want to turn on or turn off the JMX Exporter.

              • EnabledInBroker (boolean) --

                Indicates whether you want to turn on or turn off the JMX Exporter.

            • NodeExporter (dict) --

              Indicates whether you want to turn on or turn off the Node Exporter.

              • EnabledInBroker (boolean) --

                Indicates whether you want to turn on or turn off the Node Exporter.

        • ZookeeperAccess (dict) --

          Access control settings for zookeeper

          • Enabled (boolean) --

            Zookeeper Access was on or off for the cluster

        • KafkaVersion (string) --

          The Apache Kafka version.

        • LoggingInfo (dict) --

          You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

          • AuthorizerLogs (dict) --

            You can configure your MSK cluster to send authorizer logs to different destination types.

            • CloudWatchLogs (dict) --

              Details of the CloudWatch Logs destination for authorizer logs.

              • Enabled (boolean) --

              • LogGroup (string) --

            • Firehose (dict) --

              Details of the Kinesis Data Firehose delivery stream that is the destination for authorizer logs.

              • DeliveryStream (string) --

              • Enabled (boolean) --

            • S3 (dict) --

              Details of the Amazon S3 destination for authorizer logs.

              • Bucket (string) --

              • Enabled (boolean) --

              • Prefix (string) --

          • BrokerLogs (dict) --

            • CloudWatchLogs (dict) --

              • Enabled (boolean) --

              • LogGroup (string) --

            • Firehose (dict) --

              • DeliveryStream (string) --

              • Enabled (boolean) --

            • S3 (dict) --

              • Bucket (string) --

              • Enabled (boolean) --

              • Prefix (string) --

        • InstanceType (string) --

          Information about the Amazon MSK broker type.

        • ClientAuthentication (dict) --

          Includes all client authentication information.

          • Sasl (dict) --

            Details for ClientAuthentication using SASL.

            • Scram (dict) --

              Details for SASL/SCRAM client authentication.

              • Enabled (boolean) --

                SASL/SCRAM authentication is enabled or not.

            • Iam (dict) --

              Indicates whether IAM access control is enabled.

              • Enabled (boolean) --

                Indicates whether IAM access control is enabled.

          • Tls (dict) --

            Details for ClientAuthentication using TLS.

            • CertificateAuthorityArnList (list) --

              List of ACM Certificate Authority ARNs.

              • (string) --

            • Enabled (boolean) --

              Specifies whether you want to turn on or turn off TLS authentication.

          • Unauthenticated (dict) --

            Contains information about unauthenticated traffic to the cluster.

            • Enabled (boolean) --

              Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

        • EncryptionInfo (dict) --

          Includes all encryption-related information.

          • EncryptionAtRest (dict) --

            The data-volume encryption details.

            • DataVolumeKMSKeyId (string) --

              The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

          • EncryptionInTransit (dict) --

            The details for encryption in transit.

            • ClientBroker (string) --

              Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

              TLS means that client-broker communication is enabled with TLS only.

              TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

              PLAINTEXT means that client-broker communication is enabled in plaintext only.

              The default value is TLS_PLAINTEXT.

            • InCluster (boolean) --

              When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

              The default value is true.

        • ConnectivityInfo (dict) --

          Information about the broker access configuration.

          • PublicAccess (dict) --

            Public access control for brokers.

            • Type (string) --

              The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

          • VpcConnectivity (dict) --

            VPC connectivity access control for brokers.

            • ClientAuthentication (dict) --

              Includes all client authentication information for VPC connectivity.

              • Sasl (dict) --

                SASL authentication type details for VPC connectivity.

                • Scram (dict) --

                  Details for SASL/SCRAM client authentication for VPC connectivity.

                  • Enabled (boolean) --

                    SASL/SCRAM authentication is on or off for VPC connectivity.

                • Iam (dict) --

                  Details for SASL/IAM client authentication for VPC connectivity.

                  • Enabled (boolean) --

                    SASL/IAM authentication is on or off for VPC connectivity.

              • Tls (dict) --

                TLS authentication type details for VPC connectivity.

                • Enabled (boolean) --

                  TLS authentication is on or off for VPC connectivity.

          • NetworkType (string) --

            The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

            By default, a cluster uses the IPv4 network type.

        • StorageMode (string) --

          This controls storage mode for supported storage tiers.

        • BrokerCountUpdateInfo (dict) --

          Describes brokers being changed during a broker count update.

          • CreatedBrokerIds (list) --

            Kafka Broker IDs of brokers being created.

            • (float) --

          • DeletedBrokerIds (list) --

            Kafka Broker IDs of brokers being deleted.

            • (float) --

        • Rebalancing (dict) --

          Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

          • Status (string) --

            Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

      • VpcConnectionInfo (dict) --

        Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

        • VpcConnectionArn (string) --

          The Amazon Resource Name (ARN) of the VPC connection.

        • Owner (string) --

          The owner of the VPC Connection.

        • UserIdentity (dict) --

          Description of the requester that calls the API operation.

          • Type (string) --

            The identity type of the requester that calls the API operation.

          • PrincipalId (string) --

            A unique identifier for the requester that calls the API operation.

        • CreationTime (datetime) --

          The time when Amazon MSK creates the VPC Connnection.

DescribeClusterOperationV2 (updated) Link ¶
Changes (response)
{'ClusterOperationInfo': {'Provisioned': {'BrokerTypeUpgradeInfo': {'TopicReassignmentMode': 'AUTO '
                                                                                             '| '
                                                                                             'MANUAL',
                                                                    'TopicReassignmentOperationArn': 'string'}}}}

Returns a description of the cluster operation specified by the ARN.

See also: AWS API Documentation

Request Syntax

client.describe_cluster_operation_v2(
    ClusterOperationArn='string'
)
type ClusterOperationArn:

string

param ClusterOperationArn:

[REQUIRED] ARN of the cluster operation to describe.

rtype:

dict

returns:

Response Syntax

{
    'ClusterOperationInfo': {
        'ClusterArn': 'string',
        'ClusterType': 'PROVISIONED'|'SERVERLESS',
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'ErrorInfo': {
            'ErrorCode': 'string',
            'ErrorString': 'string'
        },
        'OperationArn': 'string',
        'OperationState': 'string',
        'OperationType': 'string',
        'Provisioned': {
            'BrokerTypeUpgradeInfo': {
                'TopicReassignmentMode': 'AUTO'|'MANUAL',
                'TopicReassignmentOperationArn': 'string'
            },
            'OperationSteps': [
                {
                    'StepInfo': {
                        'StepStatus': 'string'
                    },
                    'StepName': 'string'
                },
            ],
            'SourceClusterInfo': {
                'BrokerEBSVolumeInfo': [
                    {
                        'KafkaBrokerNodeId': 'string',
                        'ProvisionedThroughput': {
                            'Enabled': True|False,
                            'VolumeThroughput': 123
                        },
                        'VolumeSizeGB': 123
                    },
                ],
                'ConfigurationInfo': {
                    'Arn': 'string',
                    'Revision': 123
                },
                'NumberOfBrokerNodes': 123,
                'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
                'OpenMonitoring': {
                    'Prometheus': {
                        'JmxExporter': {
                            'EnabledInBroker': True|False
                        },
                        'NodeExporter': {
                            'EnabledInBroker': True|False
                        }
                    }
                },
                'ZookeeperAccess': {
                    'Enabled': True|False
                },
                'KafkaVersion': 'string',
                'LoggingInfo': {
                    'AuthorizerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    },
                    'BrokerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    }
                },
                'InstanceType': 'string',
                'ClientAuthentication': {
                    'Sasl': {
                        'Scram': {
                            'Enabled': True|False
                        },
                        'Iam': {
                            'Enabled': True|False
                        }
                    },
                    'Tls': {
                        'CertificateAuthorityArnList': [
                            'string',
                        ],
                        'Enabled': True|False
                    },
                    'Unauthenticated': {
                        'Enabled': True|False
                    }
                },
                'EncryptionInfo': {
                    'EncryptionAtRest': {
                        'DataVolumeKMSKeyId': 'string'
                    },
                    'EncryptionInTransit': {
                        'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
                        'InCluster': True|False
                    }
                },
                'ConnectivityInfo': {
                    'PublicAccess': {
                        'Type': 'string'
                    },
                    'VpcConnectivity': {
                        'ClientAuthentication': {
                            'Sasl': {
                                'Scram': {
                                    'Enabled': True|False
                                },
                                'Iam': {
                                    'Enabled': True|False
                                }
                            },
                            'Tls': {
                                'Enabled': True|False
                            }
                        }
                    },
                    'NetworkType': 'IPV4'|'DUAL'
                },
                'StorageMode': 'LOCAL'|'TIERED',
                'BrokerCountUpdateInfo': {
                    'CreatedBrokerIds': [
                        123.0,
                    ],
                    'DeletedBrokerIds': [
                        123.0,
                    ]
                },
                'Rebalancing': {
                    'Status': 'PAUSED'|'ACTIVE'
                }
            },
            'TargetClusterInfo': {
                'BrokerEBSVolumeInfo': [
                    {
                        'KafkaBrokerNodeId': 'string',
                        'ProvisionedThroughput': {
                            'Enabled': True|False,
                            'VolumeThroughput': 123
                        },
                        'VolumeSizeGB': 123
                    },
                ],
                'ConfigurationInfo': {
                    'Arn': 'string',
                    'Revision': 123
                },
                'NumberOfBrokerNodes': 123,
                'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
                'OpenMonitoring': {
                    'Prometheus': {
                        'JmxExporter': {
                            'EnabledInBroker': True|False
                        },
                        'NodeExporter': {
                            'EnabledInBroker': True|False
                        }
                    }
                },
                'ZookeeperAccess': {
                    'Enabled': True|False
                },
                'KafkaVersion': 'string',
                'LoggingInfo': {
                    'AuthorizerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    },
                    'BrokerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    }
                },
                'InstanceType': 'string',
                'ClientAuthentication': {
                    'Sasl': {
                        'Scram': {
                            'Enabled': True|False
                        },
                        'Iam': {
                            'Enabled': True|False
                        }
                    },
                    'Tls': {
                        'CertificateAuthorityArnList': [
                            'string',
                        ],
                        'Enabled': True|False
                    },
                    'Unauthenticated': {
                        'Enabled': True|False
                    }
                },
                'EncryptionInfo': {
                    'EncryptionAtRest': {
                        'DataVolumeKMSKeyId': 'string'
                    },
                    'EncryptionInTransit': {
                        'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
                        'InCluster': True|False
                    }
                },
                'ConnectivityInfo': {
                    'PublicAccess': {
                        'Type': 'string'
                    },
                    'VpcConnectivity': {
                        'ClientAuthentication': {
                            'Sasl': {
                                'Scram': {
                                    'Enabled': True|False
                                },
                                'Iam': {
                                    'Enabled': True|False
                                }
                            },
                            'Tls': {
                                'Enabled': True|False
                            }
                        }
                    },
                    'NetworkType': 'IPV4'|'DUAL'
                },
                'StorageMode': 'LOCAL'|'TIERED',
                'BrokerCountUpdateInfo': {
                    'CreatedBrokerIds': [
                        123.0,
                    ],
                    'DeletedBrokerIds': [
                        123.0,
                    ]
                },
                'Rebalancing': {
                    'Status': 'PAUSED'|'ACTIVE'
                }
            },
            'VpcConnectionInfo': {
                'VpcConnectionArn': 'string',
                'Owner': 'string',
                'UserIdentity': {
                    'Type': 'AWSACCOUNT'|'AWSSERVICE',
                    'PrincipalId': 'string'
                },
                'CreationTime': datetime(2015, 1, 1)
            }
        },
        'Serverless': {
            'SourceClusterInfo': {
                'NetworkType': 'IPV4'|'DUAL'
            },
            'TargetClusterInfo': {
                'NetworkType': 'IPV4'|'DUAL'
            },
            'VpcConnectionInfo': {
                'CreationTime': datetime(2015, 1, 1),
                'Owner': 'string',
                'UserIdentity': {
                    'Type': 'AWSACCOUNT'|'AWSSERVICE',
                    'PrincipalId': 'string'
                },
                'VpcConnectionArn': 'string'
            }
        }
    }
}

Response Structure

  • (dict) --

    HTTP Status Code 200: OK.

    • ClusterOperationInfo (dict) --

      Cluster operation information

      • ClusterArn (string) --

        ARN of the cluster.

      • ClusterType (string) --

        Type of the backend cluster.

      • StartTime (datetime) --

        The time at which operation was started.

      • EndTime (datetime) --

        The time at which the operation finished.

      • ErrorInfo (dict) --

        If cluster operation failed from an error, it describes the error.

        • ErrorCode (string) --

          A number describing the error programmatically.

        • ErrorString (string) --

          An optional field to provide more details about the error.

      • OperationArn (string) --

        ARN of the cluster operation.

      • OperationState (string) --

        State of the cluster operation.

      • OperationType (string) --

        Type of the cluster operation.

      • Provisioned (dict) --

        Properties of a provisioned cluster.

        • BrokerTypeUpgradeInfo (dict) --

          Topic reassignment details of the UpdateBrokerType operation that started an upgrade from Standard brokers to Express brokers.

          • TopicReassignmentMode (string) --

            How topics are reassigned to the Express brokers.

          • TopicReassignmentOperationArn (string) --

            The Amazon Resource Name (ARN) of the topic reassignment operation that Amazon MSK started for this upgrade. Present once that reassignment has started. Under MANUAL you start reassignments yourself, so Amazon MSK starts none.

        • OperationSteps (list) --

          Steps completed during the operation.

          • (dict) --

            Step taken during a cluster operation.

            • StepInfo (dict) --

              Information about the step and its status.

              • StepStatus (string) --

                The steps current status.

            • StepName (string) --

              The name of the step.

        • SourceClusterInfo (dict) --

          Information about cluster attributes before a cluster is updated.

          • BrokerEBSVolumeInfo (list) --

            Specifies the size of the EBS volume and the ID of the associated broker.

            • (dict) --

              Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

              • KafkaBrokerNodeId (string) --

                The ID of the broker to update.

              • ProvisionedThroughput (dict) --

                EBS volume provisioned throughput information.

                • Enabled (boolean) --

                  Provisioned throughput is enabled or not.

                • VolumeThroughput (integer) --

                  Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

              • VolumeSizeGB (integer) --

                Size of the EBS volume to update.

          • ConfigurationInfo (dict) --

            Information about the changes in the configuration of the brokers.

            • Arn (string) --

              ARN of the configuration to use.

            • Revision (integer) --

              The revision of the configuration to use.

          • NumberOfBrokerNodes (integer) --

            The number of broker nodes in the cluster.

          • EnhancedMonitoring (string) --

            Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

          • OpenMonitoring (dict) --

            The settings for open monitoring.

            • Prometheus (dict) --

              Prometheus settings.

              • JmxExporter (dict) --

                Indicates whether you want to turn on or turn off the JMX Exporter.

                • EnabledInBroker (boolean) --

                  Indicates whether you want to turn on or turn off the JMX Exporter.

              • NodeExporter (dict) --

                Indicates whether you want to turn on or turn off the Node Exporter.

                • EnabledInBroker (boolean) --

                  Indicates whether you want to turn on or turn off the Node Exporter.

          • ZookeeperAccess (dict) --

            Access control settings for zookeeper

            • Enabled (boolean) --

              Zookeeper Access was on or off for the cluster

          • KafkaVersion (string) --

            The Apache Kafka version.

          • LoggingInfo (dict) --

            You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

            • AuthorizerLogs (dict) --

              You can configure your MSK cluster to send authorizer logs to different destination types.

              • CloudWatchLogs (dict) --

                Details of the CloudWatch Logs destination for authorizer logs.

                • Enabled (boolean) --

                • LogGroup (string) --

              • Firehose (dict) --

                Details of the Kinesis Data Firehose delivery stream that is the destination for authorizer logs.

                • DeliveryStream (string) --

                • Enabled (boolean) --

              • S3 (dict) --

                Details of the Amazon S3 destination for authorizer logs.

                • Bucket (string) --

                • Enabled (boolean) --

                • Prefix (string) --

            • BrokerLogs (dict) --

              • CloudWatchLogs (dict) --

                • Enabled (boolean) --

                • LogGroup (string) --

              • Firehose (dict) --

                • DeliveryStream (string) --

                • Enabled (boolean) --

              • S3 (dict) --

                • Bucket (string) --

                • Enabled (boolean) --

                • Prefix (string) --

          • InstanceType (string) --

            Information about the Amazon MSK broker type.

          • ClientAuthentication (dict) --

            Includes all client authentication information.

            • Sasl (dict) --

              Details for ClientAuthentication using SASL.

              • Scram (dict) --

                Details for SASL/SCRAM client authentication.

                • Enabled (boolean) --

                  SASL/SCRAM authentication is enabled or not.

              • Iam (dict) --

                Indicates whether IAM access control is enabled.

                • Enabled (boolean) --

                  Indicates whether IAM access control is enabled.

            • Tls (dict) --

              Details for ClientAuthentication using TLS.

              • CertificateAuthorityArnList (list) --

                List of ACM Certificate Authority ARNs.

                • (string) --

              • Enabled (boolean) --

                Specifies whether you want to turn on or turn off TLS authentication.

            • Unauthenticated (dict) --

              Contains information about unauthenticated traffic to the cluster.

              • Enabled (boolean) --

                Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

          • EncryptionInfo (dict) --

            Includes all encryption-related information.

            • EncryptionAtRest (dict) --

              The data-volume encryption details.

              • DataVolumeKMSKeyId (string) --

                The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

            • EncryptionInTransit (dict) --

              The details for encryption in transit.

              • ClientBroker (string) --

                Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

                TLS means that client-broker communication is enabled with TLS only.

                TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

                PLAINTEXT means that client-broker communication is enabled in plaintext only.

                The default value is TLS_PLAINTEXT.

              • InCluster (boolean) --

                When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

                The default value is true.

          • ConnectivityInfo (dict) --

            Information about the broker access configuration.

            • PublicAccess (dict) --

              Public access control for brokers.

              • Type (string) --

                The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

            • VpcConnectivity (dict) --

              VPC connectivity access control for brokers.

              • ClientAuthentication (dict) --

                Includes all client authentication information for VPC connectivity.

                • Sasl (dict) --

                  SASL authentication type details for VPC connectivity.

                  • Scram (dict) --

                    Details for SASL/SCRAM client authentication for VPC connectivity.

                    • Enabled (boolean) --

                      SASL/SCRAM authentication is on or off for VPC connectivity.

                  • Iam (dict) --

                    Details for SASL/IAM client authentication for VPC connectivity.

                    • Enabled (boolean) --

                      SASL/IAM authentication is on or off for VPC connectivity.

                • Tls (dict) --

                  TLS authentication type details for VPC connectivity.

                  • Enabled (boolean) --

                    TLS authentication is on or off for VPC connectivity.

            • NetworkType (string) --

              The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

              By default, a cluster uses the IPv4 network type.

          • StorageMode (string) --

            This controls storage mode for supported storage tiers.

          • BrokerCountUpdateInfo (dict) --

            Describes brokers being changed during a broker count update.

            • CreatedBrokerIds (list) --

              Kafka Broker IDs of brokers being created.

              • (float) --

            • DeletedBrokerIds (list) --

              Kafka Broker IDs of brokers being deleted.

              • (float) --

          • Rebalancing (dict) --

            Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

            • Status (string) --

              Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

        • TargetClusterInfo (dict) --

          Information about cluster attributes after a cluster is updated.

          • BrokerEBSVolumeInfo (list) --

            Specifies the size of the EBS volume and the ID of the associated broker.

            • (dict) --

              Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

              • KafkaBrokerNodeId (string) --

                The ID of the broker to update.

              • ProvisionedThroughput (dict) --

                EBS volume provisioned throughput information.

                • Enabled (boolean) --

                  Provisioned throughput is enabled or not.

                • VolumeThroughput (integer) --

                  Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

              • VolumeSizeGB (integer) --

                Size of the EBS volume to update.

          • ConfigurationInfo (dict) --

            Information about the changes in the configuration of the brokers.

            • Arn (string) --

              ARN of the configuration to use.

            • Revision (integer) --

              The revision of the configuration to use.

          • NumberOfBrokerNodes (integer) --

            The number of broker nodes in the cluster.

          • EnhancedMonitoring (string) --

            Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

          • OpenMonitoring (dict) --

            The settings for open monitoring.

            • Prometheus (dict) --

              Prometheus settings.

              • JmxExporter (dict) --

                Indicates whether you want to turn on or turn off the JMX Exporter.

                • EnabledInBroker (boolean) --

                  Indicates whether you want to turn on or turn off the JMX Exporter.

              • NodeExporter (dict) --

                Indicates whether you want to turn on or turn off the Node Exporter.

                • EnabledInBroker (boolean) --

                  Indicates whether you want to turn on or turn off the Node Exporter.

          • ZookeeperAccess (dict) --

            Access control settings for zookeeper

            • Enabled (boolean) --

              Zookeeper Access was on or off for the cluster

          • KafkaVersion (string) --

            The Apache Kafka version.

          • LoggingInfo (dict) --

            You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

            • AuthorizerLogs (dict) --

              You can configure your MSK cluster to send authorizer logs to different destination types.

              • CloudWatchLogs (dict) --

                Details of the CloudWatch Logs destination for authorizer logs.

                • Enabled (boolean) --

                • LogGroup (string) --

              • Firehose (dict) --

                Details of the Kinesis Data Firehose delivery stream that is the destination for authorizer logs.

                • DeliveryStream (string) --

                • Enabled (boolean) --

              • S3 (dict) --

                Details of the Amazon S3 destination for authorizer logs.

                • Bucket (string) --

                • Enabled (boolean) --

                • Prefix (string) --

            • BrokerLogs (dict) --

              • CloudWatchLogs (dict) --

                • Enabled (boolean) --

                • LogGroup (string) --

              • Firehose (dict) --

                • DeliveryStream (string) --

                • Enabled (boolean) --

              • S3 (dict) --

                • Bucket (string) --

                • Enabled (boolean) --

                • Prefix (string) --

          • InstanceType (string) --

            Information about the Amazon MSK broker type.

          • ClientAuthentication (dict) --

            Includes all client authentication information.

            • Sasl (dict) --

              Details for ClientAuthentication using SASL.

              • Scram (dict) --

                Details for SASL/SCRAM client authentication.

                • Enabled (boolean) --

                  SASL/SCRAM authentication is enabled or not.

              • Iam (dict) --

                Indicates whether IAM access control is enabled.

                • Enabled (boolean) --

                  Indicates whether IAM access control is enabled.

            • Tls (dict) --

              Details for ClientAuthentication using TLS.

              • CertificateAuthorityArnList (list) --

                List of ACM Certificate Authority ARNs.

                • (string) --

              • Enabled (boolean) --

                Specifies whether you want to turn on or turn off TLS authentication.

            • Unauthenticated (dict) --

              Contains information about unauthenticated traffic to the cluster.

              • Enabled (boolean) --

                Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

          • EncryptionInfo (dict) --

            Includes all encryption-related information.

            • EncryptionAtRest (dict) --

              The data-volume encryption details.

              • DataVolumeKMSKeyId (string) --

                The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

            • EncryptionInTransit (dict) --

              The details for encryption in transit.

              • ClientBroker (string) --

                Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

                TLS means that client-broker communication is enabled with TLS only.

                TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

                PLAINTEXT means that client-broker communication is enabled in plaintext only.

                The default value is TLS_PLAINTEXT.

              • InCluster (boolean) --

                When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

                The default value is true.

          • ConnectivityInfo (dict) --

            Information about the broker access configuration.

            • PublicAccess (dict) --

              Public access control for brokers.

              • Type (string) --

                The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

            • VpcConnectivity (dict) --

              VPC connectivity access control for brokers.

              • ClientAuthentication (dict) --

                Includes all client authentication information for VPC connectivity.

                • Sasl (dict) --

                  SASL authentication type details for VPC connectivity.

                  • Scram (dict) --

                    Details for SASL/SCRAM client authentication for VPC connectivity.

                    • Enabled (boolean) --

                      SASL/SCRAM authentication is on or off for VPC connectivity.

                  • Iam (dict) --

                    Details for SASL/IAM client authentication for VPC connectivity.

                    • Enabled (boolean) --

                      SASL/IAM authentication is on or off for VPC connectivity.

                • Tls (dict) --

                  TLS authentication type details for VPC connectivity.

                  • Enabled (boolean) --

                    TLS authentication is on or off for VPC connectivity.

            • NetworkType (string) --

              The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

              By default, a cluster uses the IPv4 network type.

          • StorageMode (string) --

            This controls storage mode for supported storage tiers.

          • BrokerCountUpdateInfo (dict) --

            Describes brokers being changed during a broker count update.

            • CreatedBrokerIds (list) --

              Kafka Broker IDs of brokers being created.

              • (float) --

            • DeletedBrokerIds (list) --

              Kafka Broker IDs of brokers being deleted.

              • (float) --

          • Rebalancing (dict) --

            Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

            • Status (string) --

              Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

        • VpcConnectionInfo (dict) --

          Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

          • VpcConnectionArn (string) --

            The Amazon Resource Name (ARN) of the VPC connection.

          • Owner (string) --

            The owner of the VPC Connection.

          • UserIdentity (dict) --

            Description of the requester that calls the API operation.

            • Type (string) --

              The identity type of the requester that calls the API operation.

            • PrincipalId (string) --

              A unique identifier for the requester that calls the API operation.

          • CreationTime (datetime) --

            The time when Amazon MSK creates the VPC Connnection.

      • Serverless (dict) --

        Properties of a serverless cluster.

        • SourceClusterInfo (dict) --

          Describes the cluster's attributes before any updates are applied. For example, networkType, which can be either IPv4 or DUAL.

          • NetworkType (string) --

            The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

            By default, a cluster uses the IPv4 network type.

        • TargetClusterInfo (dict) --

          Describes the cluster's attributes after any updates are applied. For example, networkType, which can be either IPv4 or DUAL.

          • NetworkType (string) --

            The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

            By default, a cluster uses the IPv4 network type.

        • VpcConnectionInfo (dict) --

          Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

          • CreationTime (datetime) --

            The time when Amazon MSK creates the VPC Connnection.

          • Owner (string) --

            The owner of the VPC Connection.

          • UserIdentity (dict) --

            Description of the requester that calls the API operation.

            • Type (string) --

              The identity type of the requester that calls the API operation.

            • PrincipalId (string) --

              A unique identifier for the requester that calls the API operation.

          • VpcConnectionArn (string) --

            The Amazon Resource Name (ARN) of the VPC connection.

DescribeTopic (updated) Link ¶
Changes (response)
{'ReplicaIds': ['integer']}

Returns topic details of this topic on a MSK cluster.

See also: AWS API Documentation

Request Syntax

client.describe_topic(
    ClusterArn='string',
    TopicName='string'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

type TopicName:

string

param TopicName:

[REQUIRED]

The Kafka topic name that uniquely identifies the topic.

rtype:

dict

returns:

Response Syntax

{
    'TopicArn': 'string',
    'TopicName': 'string',
    'ReplicationFactor': 123,
    'PartitionCount': 123,
    'Configs': 'string',
    'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
    'ReplicaIds': [
        123,
    ]
}

Response Structure

  • (dict) --

    200 response

    • TopicArn (string) --

      The Amazon Resource Name (ARN) of the topic.

    • TopicName (string) --

      The Kafka topic name of the topic.

    • ReplicationFactor (integer) --

      The replication factor of the topic.

    • PartitionCount (integer) --

      The partition count of the topic.

    • Configs (string) --

      Topic configurations encoded as a Base64 string.

    • Status (string) --

      The status of the topic.

    • ReplicaIds (list) --

      The broker IDs hosting replicas of this topic's partitions.

      • (integer) --

ListClusterOperations (updated) Link ¶
Changes (response)
{'ClusterOperationInfoList': {'BrokerTypeUpgradeInfo': {'TopicReassignmentMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL',
                                                        'TopicReassignmentOperationArn': 'string'}}}

Returns a list of all the operations that have been performed on the specified MSK cluster.

See also: AWS API Documentation

Request Syntax

client.list_cluster_operations(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

type NextToken:

string

param NextToken:

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

rtype:

dict

returns:

Response Syntax

{
    'ClusterOperationInfoList': [
        {
            'BrokerTypeUpgradeInfo': {
                'TopicReassignmentMode': 'AUTO'|'MANUAL',
                'TopicReassignmentOperationArn': 'string'
            },
            'ClientRequestId': 'string',
            'ClusterArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'ErrorInfo': {
                'ErrorCode': 'string',
                'ErrorString': 'string'
            },
            'OperationArn': 'string',
            'OperationState': 'string',
            'OperationSteps': [
                {
                    'StepInfo': {
                        'StepStatus': 'string'
                    },
                    'StepName': 'string'
                },
            ],
            'OperationType': 'string',
            'SourceClusterInfo': {
                'BrokerEBSVolumeInfo': [
                    {
                        'KafkaBrokerNodeId': 'string',
                        'ProvisionedThroughput': {
                            'Enabled': True|False,
                            'VolumeThroughput': 123
                        },
                        'VolumeSizeGB': 123
                    },
                ],
                'ConfigurationInfo': {
                    'Arn': 'string',
                    'Revision': 123
                },
                'NumberOfBrokerNodes': 123,
                'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
                'OpenMonitoring': {
                    'Prometheus': {
                        'JmxExporter': {
                            'EnabledInBroker': True|False
                        },
                        'NodeExporter': {
                            'EnabledInBroker': True|False
                        }
                    }
                },
                'ZookeeperAccess': {
                    'Enabled': True|False
                },
                'KafkaVersion': 'string',
                'LoggingInfo': {
                    'AuthorizerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    },
                    'BrokerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    }
                },
                'InstanceType': 'string',
                'ClientAuthentication': {
                    'Sasl': {
                        'Scram': {
                            'Enabled': True|False
                        },
                        'Iam': {
                            'Enabled': True|False
                        }
                    },
                    'Tls': {
                        'CertificateAuthorityArnList': [
                            'string',
                        ],
                        'Enabled': True|False
                    },
                    'Unauthenticated': {
                        'Enabled': True|False
                    }
                },
                'EncryptionInfo': {
                    'EncryptionAtRest': {
                        'DataVolumeKMSKeyId': 'string'
                    },
                    'EncryptionInTransit': {
                        'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
                        'InCluster': True|False
                    }
                },
                'ConnectivityInfo': {
                    'PublicAccess': {
                        'Type': 'string'
                    },
                    'VpcConnectivity': {
                        'ClientAuthentication': {
                            'Sasl': {
                                'Scram': {
                                    'Enabled': True|False
                                },
                                'Iam': {
                                    'Enabled': True|False
                                }
                            },
                            'Tls': {
                                'Enabled': True|False
                            }
                        }
                    },
                    'NetworkType': 'IPV4'|'DUAL'
                },
                'StorageMode': 'LOCAL'|'TIERED',
                'BrokerCountUpdateInfo': {
                    'CreatedBrokerIds': [
                        123.0,
                    ],
                    'DeletedBrokerIds': [
                        123.0,
                    ]
                },
                'Rebalancing': {
                    'Status': 'PAUSED'|'ACTIVE'
                }
            },
            'TargetClusterInfo': {
                'BrokerEBSVolumeInfo': [
                    {
                        'KafkaBrokerNodeId': 'string',
                        'ProvisionedThroughput': {
                            'Enabled': True|False,
                            'VolumeThroughput': 123
                        },
                        'VolumeSizeGB': 123
                    },
                ],
                'ConfigurationInfo': {
                    'Arn': 'string',
                    'Revision': 123
                },
                'NumberOfBrokerNodes': 123,
                'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
                'OpenMonitoring': {
                    'Prometheus': {
                        'JmxExporter': {
                            'EnabledInBroker': True|False
                        },
                        'NodeExporter': {
                            'EnabledInBroker': True|False
                        }
                    }
                },
                'ZookeeperAccess': {
                    'Enabled': True|False
                },
                'KafkaVersion': 'string',
                'LoggingInfo': {
                    'AuthorizerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    },
                    'BrokerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    }
                },
                'InstanceType': 'string',
                'ClientAuthentication': {
                    'Sasl': {
                        'Scram': {
                            'Enabled': True|False
                        },
                        'Iam': {
                            'Enabled': True|False
                        }
                    },
                    'Tls': {
                        'CertificateAuthorityArnList': [
                            'string',
                        ],
                        'Enabled': True|False
                    },
                    'Unauthenticated': {
                        'Enabled': True|False
                    }
                },
                'EncryptionInfo': {
                    'EncryptionAtRest': {
                        'DataVolumeKMSKeyId': 'string'
                    },
                    'EncryptionInTransit': {
                        'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
                        'InCluster': True|False
                    }
                },
                'ConnectivityInfo': {
                    'PublicAccess': {
                        'Type': 'string'
                    },
                    'VpcConnectivity': {
                        'ClientAuthentication': {
                            'Sasl': {
                                'Scram': {
                                    'Enabled': True|False
                                },
                                'Iam': {
                                    'Enabled': True|False
                                }
                            },
                            'Tls': {
                                'Enabled': True|False
                            }
                        }
                    },
                    'NetworkType': 'IPV4'|'DUAL'
                },
                'StorageMode': 'LOCAL'|'TIERED',
                'BrokerCountUpdateInfo': {
                    'CreatedBrokerIds': [
                        123.0,
                    ],
                    'DeletedBrokerIds': [
                        123.0,
                    ]
                },
                'Rebalancing': {
                    'Status': 'PAUSED'|'ACTIVE'
                }
            },
            'VpcConnectionInfo': {
                'VpcConnectionArn': 'string',
                'Owner': 'string',
                'UserIdentity': {
                    'Type': 'AWSACCOUNT'|'AWSSERVICE',
                    'PrincipalId': 'string'
                },
                'CreationTime': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Successful response.

    • ClusterOperationInfoList (list) --

      An array of cluster operation information objects.

      • (dict) --

        Returns information about a cluster operation.

        • BrokerTypeUpgradeInfo (dict) --

          Topic reassignment details of the UpdateBrokerType operation that started an upgrade from Standard brokers to Express brokers.

          • TopicReassignmentMode (string) --

            How topics are reassigned to the Express brokers.

          • TopicReassignmentOperationArn (string) --

            The Amazon Resource Name (ARN) of the topic reassignment operation that Amazon MSK started for this upgrade. Present once that reassignment has started. Under MANUAL you start reassignments yourself, so Amazon MSK starts none.

        • ClientRequestId (string) --

          The ID of the API request that triggered this operation.

        • ClusterArn (string) --

          ARN of the cluster.

        • CreationTime (datetime) --

          The time that the operation was created.

        • EndTime (datetime) --

          The time at which the operation finished.

        • ErrorInfo (dict) --

          Describes the error if the operation fails.

          • ErrorCode (string) --

            A number describing the error programmatically.

          • ErrorString (string) --

            An optional field to provide more details about the error.

        • OperationArn (string) --

          ARN of the cluster operation.

        • OperationState (string) --

          State of the cluster operation.

        • OperationSteps (list) --

          Steps completed during the operation.

          • (dict) --

            Step taken during a cluster operation.

            • StepInfo (dict) --

              Information about the step and its status.

              • StepStatus (string) --

                The steps current status.

            • StepName (string) --

              The name of the step.

        • OperationType (string) --

          Type of the cluster operation.

        • SourceClusterInfo (dict) --

          Information about cluster attributes before a cluster is updated.

          • BrokerEBSVolumeInfo (list) --

            Specifies the size of the EBS volume and the ID of the associated broker.

            • (dict) --

              Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

              • KafkaBrokerNodeId (string) --

                The ID of the broker to update.

              • ProvisionedThroughput (dict) --

                EBS volume provisioned throughput information.

                • Enabled (boolean) --

                  Provisioned throughput is enabled or not.

                • VolumeThroughput (integer) --

                  Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

              • VolumeSizeGB (integer) --

                Size of the EBS volume to update.

          • ConfigurationInfo (dict) --

            Information about the changes in the configuration of the brokers.

            • Arn (string) --

              ARN of the configuration to use.

            • Revision (integer) --

              The revision of the configuration to use.

          • NumberOfBrokerNodes (integer) --

            The number of broker nodes in the cluster.

          • EnhancedMonitoring (string) --

            Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

          • OpenMonitoring (dict) --

            The settings for open monitoring.

            • Prometheus (dict) --

              Prometheus settings.

              • JmxExporter (dict) --

                Indicates whether you want to turn on or turn off the JMX Exporter.

                • EnabledInBroker (boolean) --

                  Indicates whether you want to turn on or turn off the JMX Exporter.

              • NodeExporter (dict) --

                Indicates whether you want to turn on or turn off the Node Exporter.

                • EnabledInBroker (boolean) --

                  Indicates whether you want to turn on or turn off the Node Exporter.

          • ZookeeperAccess (dict) --

            Access control settings for zookeeper

            • Enabled (boolean) --

              Zookeeper Access was on or off for the cluster

          • KafkaVersion (string) --

            The Apache Kafka version.

          • LoggingInfo (dict) --

            You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

            • AuthorizerLogs (dict) --

              You can configure your MSK cluster to send authorizer logs to different destination types.

              • CloudWatchLogs (dict) --

                Details of the CloudWatch Logs destination for authorizer logs.

                • Enabled (boolean) --

                • LogGroup (string) --

              • Firehose (dict) --

                Details of the Kinesis Data Firehose delivery stream that is the destination for authorizer logs.

                • DeliveryStream (string) --

                • Enabled (boolean) --

              • S3 (dict) --

                Details of the Amazon S3 destination for authorizer logs.

                • Bucket (string) --

                • Enabled (boolean) --

                • Prefix (string) --

            • BrokerLogs (dict) --

              • CloudWatchLogs (dict) --

                • Enabled (boolean) --

                • LogGroup (string) --

              • Firehose (dict) --

                • DeliveryStream (string) --

                • Enabled (boolean) --

              • S3 (dict) --

                • Bucket (string) --

                • Enabled (boolean) --

                • Prefix (string) --

          • InstanceType (string) --

            Information about the Amazon MSK broker type.

          • ClientAuthentication (dict) --

            Includes all client authentication information.

            • Sasl (dict) --

              Details for ClientAuthentication using SASL.

              • Scram (dict) --

                Details for SASL/SCRAM client authentication.

                • Enabled (boolean) --

                  SASL/SCRAM authentication is enabled or not.

              • Iam (dict) --

                Indicates whether IAM access control is enabled.

                • Enabled (boolean) --

                  Indicates whether IAM access control is enabled.

            • Tls (dict) --

              Details for ClientAuthentication using TLS.

              • CertificateAuthorityArnList (list) --

                List of ACM Certificate Authority ARNs.

                • (string) --

              • Enabled (boolean) --

                Specifies whether you want to turn on or turn off TLS authentication.

            • Unauthenticated (dict) --

              Contains information about unauthenticated traffic to the cluster.

              • Enabled (boolean) --

                Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

          • EncryptionInfo (dict) --

            Includes all encryption-related information.

            • EncryptionAtRest (dict) --

              The data-volume encryption details.

              • DataVolumeKMSKeyId (string) --

                The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

            • EncryptionInTransit (dict) --

              The details for encryption in transit.

              • ClientBroker (string) --

                Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

                TLS means that client-broker communication is enabled with TLS only.

                TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

                PLAINTEXT means that client-broker communication is enabled in plaintext only.

                The default value is TLS_PLAINTEXT.

              • InCluster (boolean) --

                When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

                The default value is true.

          • ConnectivityInfo (dict) --

            Information about the broker access configuration.

            • PublicAccess (dict) --

              Public access control for brokers.

              • Type (string) --

                The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

            • VpcConnectivity (dict) --

              VPC connectivity access control for brokers.

              • ClientAuthentication (dict) --

                Includes all client authentication information for VPC connectivity.

                • Sasl (dict) --

                  SASL authentication type details for VPC connectivity.

                  • Scram (dict) --

                    Details for SASL/SCRAM client authentication for VPC connectivity.

                    • Enabled (boolean) --

                      SASL/SCRAM authentication is on or off for VPC connectivity.

                  • Iam (dict) --

                    Details for SASL/IAM client authentication for VPC connectivity.

                    • Enabled (boolean) --

                      SASL/IAM authentication is on or off for VPC connectivity.

                • Tls (dict) --

                  TLS authentication type details for VPC connectivity.

                  • Enabled (boolean) --

                    TLS authentication is on or off for VPC connectivity.

            • NetworkType (string) --

              The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

              By default, a cluster uses the IPv4 network type.

          • StorageMode (string) --

            This controls storage mode for supported storage tiers.

          • BrokerCountUpdateInfo (dict) --

            Describes brokers being changed during a broker count update.

            • CreatedBrokerIds (list) --

              Kafka Broker IDs of brokers being created.

              • (float) --

            • DeletedBrokerIds (list) --

              Kafka Broker IDs of brokers being deleted.

              • (float) --

          • Rebalancing (dict) --

            Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

            • Status (string) --

              Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

        • TargetClusterInfo (dict) --

          Information about cluster attributes after a cluster is updated.

          • BrokerEBSVolumeInfo (list) --

            Specifies the size of the EBS volume and the ID of the associated broker.

            • (dict) --

              Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

              • KafkaBrokerNodeId (string) --

                The ID of the broker to update.

              • ProvisionedThroughput (dict) --

                EBS volume provisioned throughput information.

                • Enabled (boolean) --

                  Provisioned throughput is enabled or not.

                • VolumeThroughput (integer) --

                  Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

              • VolumeSizeGB (integer) --

                Size of the EBS volume to update.

          • ConfigurationInfo (dict) --

            Information about the changes in the configuration of the brokers.

            • Arn (string) --

              ARN of the configuration to use.

            • Revision (integer) --

              The revision of the configuration to use.

          • NumberOfBrokerNodes (integer) --

            The number of broker nodes in the cluster.

          • EnhancedMonitoring (string) --

            Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

          • OpenMonitoring (dict) --

            The settings for open monitoring.

            • Prometheus (dict) --

              Prometheus settings.

              • JmxExporter (dict) --

                Indicates whether you want to turn on or turn off the JMX Exporter.

                • EnabledInBroker (boolean) --

                  Indicates whether you want to turn on or turn off the JMX Exporter.

              • NodeExporter (dict) --

                Indicates whether you want to turn on or turn off the Node Exporter.

                • EnabledInBroker (boolean) --

                  Indicates whether you want to turn on or turn off the Node Exporter.

          • ZookeeperAccess (dict) --

            Access control settings for zookeeper

            • Enabled (boolean) --

              Zookeeper Access was on or off for the cluster

          • KafkaVersion (string) --

            The Apache Kafka version.

          • LoggingInfo (dict) --

            You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

            • AuthorizerLogs (dict) --

              You can configure your MSK cluster to send authorizer logs to different destination types.

              • CloudWatchLogs (dict) --

                Details of the CloudWatch Logs destination for authorizer logs.

                • Enabled (boolean) --

                • LogGroup (string) --

              • Firehose (dict) --

                Details of the Kinesis Data Firehose delivery stream that is the destination for authorizer logs.

                • DeliveryStream (string) --

                • Enabled (boolean) --

              • S3 (dict) --

                Details of the Amazon S3 destination for authorizer logs.

                • Bucket (string) --

                • Enabled (boolean) --

                • Prefix (string) --

            • BrokerLogs (dict) --

              • CloudWatchLogs (dict) --

                • Enabled (boolean) --

                • LogGroup (string) --

              • Firehose (dict) --

                • DeliveryStream (string) --

                • Enabled (boolean) --

              • S3 (dict) --

                • Bucket (string) --

                • Enabled (boolean) --

                • Prefix (string) --

          • InstanceType (string) --

            Information about the Amazon MSK broker type.

          • ClientAuthentication (dict) --

            Includes all client authentication information.

            • Sasl (dict) --

              Details for ClientAuthentication using SASL.

              • Scram (dict) --

                Details for SASL/SCRAM client authentication.

                • Enabled (boolean) --

                  SASL/SCRAM authentication is enabled or not.

              • Iam (dict) --

                Indicates whether IAM access control is enabled.

                • Enabled (boolean) --

                  Indicates whether IAM access control is enabled.

            • Tls (dict) --

              Details for ClientAuthentication using TLS.

              • CertificateAuthorityArnList (list) --

                List of ACM Certificate Authority ARNs.

                • (string) --

              • Enabled (boolean) --

                Specifies whether you want to turn on or turn off TLS authentication.

            • Unauthenticated (dict) --

              Contains information about unauthenticated traffic to the cluster.

              • Enabled (boolean) --

                Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

          • EncryptionInfo (dict) --

            Includes all encryption-related information.

            • EncryptionAtRest (dict) --

              The data-volume encryption details.

              • DataVolumeKMSKeyId (string) --

                The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

            • EncryptionInTransit (dict) --

              The details for encryption in transit.

              • ClientBroker (string) --

                Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

                TLS means that client-broker communication is enabled with TLS only.

                TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

                PLAINTEXT means that client-broker communication is enabled in plaintext only.

                The default value is TLS_PLAINTEXT.

              • InCluster (boolean) --

                When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

                The default value is true.

          • ConnectivityInfo (dict) --

            Information about the broker access configuration.

            • PublicAccess (dict) --

              Public access control for brokers.

              • Type (string) --

                The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

            • VpcConnectivity (dict) --

              VPC connectivity access control for brokers.

              • ClientAuthentication (dict) --

                Includes all client authentication information for VPC connectivity.

                • Sasl (dict) --

                  SASL authentication type details for VPC connectivity.

                  • Scram (dict) --

                    Details for SASL/SCRAM client authentication for VPC connectivity.

                    • Enabled (boolean) --

                      SASL/SCRAM authentication is on or off for VPC connectivity.

                  • Iam (dict) --

                    Details for SASL/IAM client authentication for VPC connectivity.

                    • Enabled (boolean) --

                      SASL/IAM authentication is on or off for VPC connectivity.

                • Tls (dict) --

                  TLS authentication type details for VPC connectivity.

                  • Enabled (boolean) --

                    TLS authentication is on or off for VPC connectivity.

            • NetworkType (string) --

              The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

              By default, a cluster uses the IPv4 network type.

          • StorageMode (string) --

            This controls storage mode for supported storage tiers.

          • BrokerCountUpdateInfo (dict) --

            Describes brokers being changed during a broker count update.

            • CreatedBrokerIds (list) --

              Kafka Broker IDs of brokers being created.

              • (float) --

            • DeletedBrokerIds (list) --

              Kafka Broker IDs of brokers being deleted.

              • (float) --

          • Rebalancing (dict) --

            Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

            • Status (string) --

              Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

        • VpcConnectionInfo (dict) --

          Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

          • VpcConnectionArn (string) --

            The Amazon Resource Name (ARN) of the VPC connection.

          • Owner (string) --

            The owner of the VPC Connection.

          • UserIdentity (dict) --

            Description of the requester that calls the API operation.

            • Type (string) --

              The identity type of the requester that calls the API operation.

            • PrincipalId (string) --

              A unique identifier for the requester that calls the API operation.

          • CreationTime (datetime) --

            The time when Amazon MSK creates the VPC Connnection.

    • NextToken (string) --

      If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

ListNodes (updated) Link ¶
Changes (response)
{'NodeInfoList': {'BrokerNodeInfo': {'BrokerNodeType': 'STANDARD | EXPRESS'}}}

Returns a list of the broker nodes in the cluster.

See also: AWS API Documentation

Request Syntax

client.list_nodes(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

type NextToken:

string

param NextToken:

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'NodeInfoList': [
        {
            'AddedToClusterTime': 'string',
            'BrokerNodeInfo': {
                'AttachedENIId': 'string',
                'BrokerId': 123.0,
                'BrokerNodeType': 'STANDARD'|'EXPRESS',
                'ClientSubnet': 'string',
                'ClientVpcIpAddress': 'string',
                'CurrentBrokerSoftwareInfo': {
                    'ConfigurationArn': 'string',
                    'ConfigurationRevision': 123,
                    'KafkaVersion': 'string'
                },
                'Endpoints': [
                    'string',
                ]
            },
            'ControllerNodeInfo': {
                'Endpoints': [
                    'string',
                ]
            },
            'InstanceType': 'string',
            'NodeARN': 'string',
            'NodeType': 'BROKER',
            'ZookeeperNodeInfo': {
                'AttachedENIId': 'string',
                'ClientVpcIpAddress': 'string',
                'Endpoints': [
                    'string',
                ],
                'ZookeeperId': 123.0,
                'ZookeeperVersion': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    Successful response.

    • NextToken (string) --

      The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request.

    • NodeInfoList (list) --

      List containing a NodeInfo object.

      • (dict) --

        The node information object.

        • AddedToClusterTime (string) --

          The start time.

        • BrokerNodeInfo (dict) --

          The broker node info.

          • AttachedENIId (string) --

            The attached elastic network interface of the broker.

          • BrokerId (float) --

            The ID of the broker.

          • BrokerNodeType (string) --

            Whether this broker is a Standard broker or an Express broker. While an UpdateBrokerType operation upgrades a cluster in place from Standard brokers to Express brokers, the cluster contains brokers of both types and this field tells them apart.

          • ClientSubnet (string) --

            The client subnet to which this broker node belongs.

          • ClientVpcIpAddress (string) --

            The virtual private cloud (VPC) of the client.

          • CurrentBrokerSoftwareInfo (dict) --

            Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

            • ConfigurationArn (string) --

              The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

            • ConfigurationRevision (integer) --

              The revision of the configuration to use. This field isn't visible in this preview release.

            • KafkaVersion (string) --

              The version of Apache Kafka.

          • Endpoints (list) --

            Endpoints for accessing the broker.

            • (string) --

        • ControllerNodeInfo (dict) --

          The ControllerNodeInfo.

          • Endpoints (list) --

            Endpoints for accessing the Controller.

            • (string) --

        • InstanceType (string) --

          The instance type.

        • NodeARN (string) --

          The Amazon Resource Name (ARN) of the node.

        • NodeType (string) --

          The node type.

        • ZookeeperNodeInfo (dict) --

          The ZookeeperNodeInfo.

          • AttachedENIId (string) --

            The attached elastic network interface of the broker.

          • ClientVpcIpAddress (string) --

            The virtual private cloud (VPC) IP address of the client.

          • Endpoints (list) --

            Endpoints for accessing the ZooKeeper.

            • (string) --

          • ZookeeperId (float) --

            The role-specific ID for Zookeeper.

          • ZookeeperVersion (string) --

            The version of Zookeeper.

ListTopics (updated) Link ¶
Changes (response)
{'Topics': {'ReplicaIds': ['integer']}}

List topics in a MSK cluster.

See also: AWS API Documentation

Request Syntax

client.list_topics(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string',
    TopicNameFilter='string'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

type NextToken:

string

param NextToken:

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

type TopicNameFilter:

string

param TopicNameFilter:

Returns topics starting with given name.

rtype:

dict

returns:

Response Syntax

{
    'Topics': [
        {
            'TopicArn': 'string',
            'TopicName': 'string',
            'ReplicationFactor': 123,
            'PartitionCount': 123,
            'OutOfSyncReplicaCount': 123,
            'ReplicaIds': [
                123,
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    200 response

    • Topics (list) --

      List containing topics info.

      • (dict) --

        Includes identification info about the topic.

        • TopicArn (string) --

          The Amazon Resource Name (ARN) of the topic.

        • TopicName (string) --

          Name for a topic.

        • ReplicationFactor (integer) --

          Replication factor for a topic.

        • PartitionCount (integer) --

          Partition count for a topic.

        • OutOfSyncReplicaCount (integer) --

          Number of out-of-sync replicas for a topic.

        • ReplicaIds (list) --

          The broker IDs hosting replicas of this topic's partitions.

          • (integer) --

    • NextToken (string) --

      The paginated results marker. When the result of a ListTopics operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

UpdateBrokerType (updated) Link ¶
Changes (request)
{'TopicReassignment': 'AUTO | MANUAL'}

Updates EC2 instance type.

See also: AWS API Documentation

Request Syntax

client.update_broker_type(
    ClusterArn='string',
    CurrentVersion='string',
    TargetInstanceType='string',
    TopicReassignment='AUTO'|'MANUAL'
)
type ClusterArn:

string

param ClusterArn:

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

type CurrentVersion:

string

param CurrentVersion:

[REQUIRED]

The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.

type TargetInstanceType:

string

param TargetInstanceType:

[REQUIRED]

The type of Amazon EC2 instances to use for Kafka brokers. For in-place upgrades to Express, use the composite format to initiate mixed mode, the Express instance type to complete the upgrade, or the Standard instance type to rollback.

type TopicReassignment:

string

param TopicReassignment:

Controls automatic topic reassignment when entering mixed broker mode. When set to AUTO, MSK automatically reassigns all topics to the target broker type after adding new brokers. When set to MANUAL (default), customers manage topic reassignment using the StartTopicReassignment API. Only valid when targetInstanceType is a composite mixed-mode value. Must be set to MANUAL before completing the upgrade or rolling back.

rtype:

dict

returns:

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

  • (dict) --

    Successful response.

    • ClusterArn (string) --

      The Amazon Resource Name (ARN) of the cluster.

    • ClusterOperationArn (string) --

      The Amazon Resource Name (ARN) of the cluster operation.